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.6/git.html[documentation for release 2.4.6]
49 link:RelNotes/2.4.6.txt[2.4.6],
50 link:RelNotes/2.4.5.txt[2.4.5],
51 link:RelNotes/2.4.4.txt[2.4.4],
52 link:RelNotes/2.4.3.txt[2.4.3],
53 link:RelNotes/2.4.2.txt[2.4.2],
54 link:RelNotes/2.4.1.txt[2.4.1],
55 link:RelNotes/2.4.0.txt[2.4].
57 * link:v2.3.8/git.html[documentation for release 2.3.8]
60 link:RelNotes/2.3.8.txt[2.3.8],
61 link:RelNotes/2.3.7.txt[2.3.7],
62 link:RelNotes/2.3.6.txt[2.3.6],
63 link:RelNotes/2.3.5.txt[2.3.5],
64 link:RelNotes/2.3.4.txt[2.3.4],
65 link:RelNotes/2.3.3.txt[2.3.3],
66 link:RelNotes/2.3.2.txt[2.3.2],
67 link:RelNotes/2.3.1.txt[2.3.1],
68 link:RelNotes/2.3.0.txt[2.3].
70 * link:v2.2.2/git.html[documentation for release 2.2.2]
73 link:RelNotes/2.2.2.txt[2.2.2],
74 link:RelNotes/2.2.1.txt[2.2.1],
75 link:RelNotes/2.2.0.txt[2.2].
77 * link:v2.1.4/git.html[documentation for release 2.1.4]
80 link:RelNotes/2.1.4.txt[2.1.4],
81 link:RelNotes/2.1.3.txt[2.1.3],
82 link:RelNotes/2.1.2.txt[2.1.2],
83 link:RelNotes/2.1.1.txt[2.1.1],
84 link:RelNotes/2.1.0.txt[2.1].
86 * link:v2.0.5/git.html[documentation for release 2.0.5]
89 link:RelNotes/2.0.5.txt[2.0.5],
90 link:RelNotes/2.0.4.txt[2.0.4],
91 link:RelNotes/2.0.3.txt[2.0.3],
92 link:RelNotes/2.0.2.txt[2.0.2],
93 link:RelNotes/2.0.1.txt[2.0.1],
94 link:RelNotes/2.0.0.txt[2.0.0].
96 * link:v1.9.5/git.html[documentation for release 1.9.5]
99 link:RelNotes/1.9.5.txt[1.9.5],
100 link:RelNotes/1.9.4.txt[1.9.4],
101 link:RelNotes/1.9.3.txt[1.9.3],
102 link:RelNotes/1.9.2.txt[1.9.2],
103 link:RelNotes/1.9.1.txt[1.9.1],
104 link:RelNotes/1.9.0.txt[1.9.0].
106 * link:v1.8.5.6/git.html[documentation for release 1.8.5.6]
109 link:RelNotes/1.8.5.6.txt[1.8.5.6],
110 link:RelNotes/1.8.5.5.txt[1.8.5.5],
111 link:RelNotes/1.8.5.4.txt[1.8.5.4],
112 link:RelNotes/1.8.5.3.txt[1.8.5.3],
113 link:RelNotes/1.8.5.2.txt[1.8.5.2],
114 link:RelNotes/1.8.5.1.txt[1.8.5.1],
115 link:RelNotes/1.8.5.txt[1.8.5].
117 * link:v1.8.4.5/git.html[documentation for release 1.8.4.5]
120 link:RelNotes/1.8.4.5.txt[1.8.4.5],
121 link:RelNotes/1.8.4.4.txt[1.8.4.4],
122 link:RelNotes/1.8.4.3.txt[1.8.4.3],
123 link:RelNotes/1.8.4.2.txt[1.8.4.2],
124 link:RelNotes/1.8.4.1.txt[1.8.4.1],
125 link:RelNotes/1.8.4.txt[1.8.4].
127 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
130 link:RelNotes/1.8.3.4.txt[1.8.3.4],
131 link:RelNotes/1.8.3.3.txt[1.8.3.3],
132 link:RelNotes/1.8.3.2.txt[1.8.3.2],
133 link:RelNotes/1.8.3.1.txt[1.8.3.1],
134 link:RelNotes/1.8.3.txt[1.8.3].
136 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
139 link:RelNotes/1.8.2.3.txt[1.8.2.3],
140 link:RelNotes/1.8.2.2.txt[1.8.2.2],
141 link:RelNotes/1.8.2.1.txt[1.8.2.1],
142 link:RelNotes/1.8.2.txt[1.8.2].
144 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
147 link:RelNotes/1.8.1.6.txt[1.8.1.6],
148 link:RelNotes/1.8.1.5.txt[1.8.1.5],
149 link:RelNotes/1.8.1.4.txt[1.8.1.4],
150 link:RelNotes/1.8.1.3.txt[1.8.1.3],
151 link:RelNotes/1.8.1.2.txt[1.8.1.2],
152 link:RelNotes/1.8.1.1.txt[1.8.1.1],
153 link:RelNotes/1.8.1.txt[1.8.1].
155 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
158 link:RelNotes/1.8.0.3.txt[1.8.0.3],
159 link:RelNotes/1.8.0.2.txt[1.8.0.2],
160 link:RelNotes/1.8.0.1.txt[1.8.0.1],
161 link:RelNotes/1.8.0.txt[1.8.0].
163 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
166 link:RelNotes/1.7.12.4.txt[1.7.12.4],
167 link:RelNotes/1.7.12.3.txt[1.7.12.3],
168 link:RelNotes/1.7.12.2.txt[1.7.12.2],
169 link:RelNotes/1.7.12.1.txt[1.7.12.1],
170 link:RelNotes/1.7.12.txt[1.7.12].
172 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
175 link:RelNotes/1.7.11.7.txt[1.7.11.7],
176 link:RelNotes/1.7.11.6.txt[1.7.11.6],
177 link:RelNotes/1.7.11.5.txt[1.7.11.5],
178 link:RelNotes/1.7.11.4.txt[1.7.11.4],
179 link:RelNotes/1.7.11.3.txt[1.7.11.3],
180 link:RelNotes/1.7.11.2.txt[1.7.11.2],
181 link:RelNotes/1.7.11.1.txt[1.7.11.1],
182 link:RelNotes/1.7.11.txt[1.7.11].
184 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
187 link:RelNotes/1.7.10.5.txt[1.7.10.5],
188 link:RelNotes/1.7.10.4.txt[1.7.10.4],
189 link:RelNotes/1.7.10.3.txt[1.7.10.3],
190 link:RelNotes/1.7.10.2.txt[1.7.10.2],
191 link:RelNotes/1.7.10.1.txt[1.7.10.1],
192 link:RelNotes/1.7.10.txt[1.7.10].
194 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
197 link:RelNotes/1.7.9.7.txt[1.7.9.7],
198 link:RelNotes/1.7.9.6.txt[1.7.9.6],
199 link:RelNotes/1.7.9.5.txt[1.7.9.5],
200 link:RelNotes/1.7.9.4.txt[1.7.9.4],
201 link:RelNotes/1.7.9.3.txt[1.7.9.3],
202 link:RelNotes/1.7.9.2.txt[1.7.9.2],
203 link:RelNotes/1.7.9.1.txt[1.7.9.1],
204 link:RelNotes/1.7.9.txt[1.7.9].
206 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
209 link:RelNotes/1.7.8.6.txt[1.7.8.6],
210 link:RelNotes/1.7.8.5.txt[1.7.8.5],
211 link:RelNotes/1.7.8.4.txt[1.7.8.4],
212 link:RelNotes/1.7.8.3.txt[1.7.8.3],
213 link:RelNotes/1.7.8.2.txt[1.7.8.2],
214 link:RelNotes/1.7.8.1.txt[1.7.8.1],
215 link:RelNotes/1.7.8.txt[1.7.8].
217 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
220 link:RelNotes/1.7.7.7.txt[1.7.7.7],
221 link:RelNotes/1.7.7.6.txt[1.7.7.6],
222 link:RelNotes/1.7.7.5.txt[1.7.7.5],
223 link:RelNotes/1.7.7.4.txt[1.7.7.4],
224 link:RelNotes/1.7.7.3.txt[1.7.7.3],
225 link:RelNotes/1.7.7.2.txt[1.7.7.2],
226 link:RelNotes/1.7.7.1.txt[1.7.7.1],
227 link:RelNotes/1.7.7.txt[1.7.7].
229 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
232 link:RelNotes/1.7.6.6.txt[1.7.6.6],
233 link:RelNotes/1.7.6.5.txt[1.7.6.5],
234 link:RelNotes/1.7.6.4.txt[1.7.6.4],
235 link:RelNotes/1.7.6.3.txt[1.7.6.3],
236 link:RelNotes/1.7.6.2.txt[1.7.6.2],
237 link:RelNotes/1.7.6.1.txt[1.7.6.1],
238 link:RelNotes/1.7.6.txt[1.7.6].
240 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
243 link:RelNotes/1.7.5.4.txt[1.7.5.4],
244 link:RelNotes/1.7.5.3.txt[1.7.5.3],
245 link:RelNotes/1.7.5.2.txt[1.7.5.2],
246 link:RelNotes/1.7.5.1.txt[1.7.5.1],
247 link:RelNotes/1.7.5.txt[1.7.5].
249 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
252 link:RelNotes/1.7.4.5.txt[1.7.4.5],
253 link:RelNotes/1.7.4.4.txt[1.7.4.4],
254 link:RelNotes/1.7.4.3.txt[1.7.4.3],
255 link:RelNotes/1.7.4.2.txt[1.7.4.2],
256 link:RelNotes/1.7.4.1.txt[1.7.4.1],
257 link:RelNotes/1.7.4.txt[1.7.4].
259 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
262 link:RelNotes/1.7.3.5.txt[1.7.3.5],
263 link:RelNotes/1.7.3.4.txt[1.7.3.4],
264 link:RelNotes/1.7.3.3.txt[1.7.3.3],
265 link:RelNotes/1.7.3.2.txt[1.7.3.2],
266 link:RelNotes/1.7.3.1.txt[1.7.3.1],
267 link:RelNotes/1.7.3.txt[1.7.3].
269 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
272 link:RelNotes/1.7.2.5.txt[1.7.2.5],
273 link:RelNotes/1.7.2.4.txt[1.7.2.4],
274 link:RelNotes/1.7.2.3.txt[1.7.2.3],
275 link:RelNotes/1.7.2.2.txt[1.7.2.2],
276 link:RelNotes/1.7.2.1.txt[1.7.2.1],
277 link:RelNotes/1.7.2.txt[1.7.2].
279 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
282 link:RelNotes/1.7.1.4.txt[1.7.1.4],
283 link:RelNotes/1.7.1.3.txt[1.7.1.3],
284 link:RelNotes/1.7.1.2.txt[1.7.1.2],
285 link:RelNotes/1.7.1.1.txt[1.7.1.1],
286 link:RelNotes/1.7.1.txt[1.7.1].
288 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
291 link:RelNotes/1.7.0.9.txt[1.7.0.9],
292 link:RelNotes/1.7.0.8.txt[1.7.0.8],
293 link:RelNotes/1.7.0.7.txt[1.7.0.7],
294 link:RelNotes/1.7.0.6.txt[1.7.0.6],
295 link:RelNotes/1.7.0.5.txt[1.7.0.5],
296 link:RelNotes/1.7.0.4.txt[1.7.0.4],
297 link:RelNotes/1.7.0.3.txt[1.7.0.3],
298 link:RelNotes/1.7.0.2.txt[1.7.0.2],
299 link:RelNotes/1.7.0.1.txt[1.7.0.1],
300 link:RelNotes/1.7.0.txt[1.7.0].
302 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
305 link:RelNotes/1.6.6.3.txt[1.6.6.3],
306 link:RelNotes/1.6.6.2.txt[1.6.6.2],
307 link:RelNotes/1.6.6.1.txt[1.6.6.1],
308 link:RelNotes/1.6.6.txt[1.6.6].
310 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
313 link:RelNotes/1.6.5.9.txt[1.6.5.9],
314 link:RelNotes/1.6.5.8.txt[1.6.5.8],
315 link:RelNotes/1.6.5.7.txt[1.6.5.7],
316 link:RelNotes/1.6.5.6.txt[1.6.5.6],
317 link:RelNotes/1.6.5.5.txt[1.6.5.5],
318 link:RelNotes/1.6.5.4.txt[1.6.5.4],
319 link:RelNotes/1.6.5.3.txt[1.6.5.3],
320 link:RelNotes/1.6.5.2.txt[1.6.5.2],
321 link:RelNotes/1.6.5.1.txt[1.6.5.1],
322 link:RelNotes/1.6.5.txt[1.6.5].
324 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
327 link:RelNotes/1.6.4.5.txt[1.6.4.5],
328 link:RelNotes/1.6.4.4.txt[1.6.4.4],
329 link:RelNotes/1.6.4.3.txt[1.6.4.3],
330 link:RelNotes/1.6.4.2.txt[1.6.4.2],
331 link:RelNotes/1.6.4.1.txt[1.6.4.1],
332 link:RelNotes/1.6.4.txt[1.6.4].
334 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
337 link:RelNotes/1.6.3.4.txt[1.6.3.4],
338 link:RelNotes/1.6.3.3.txt[1.6.3.3],
339 link:RelNotes/1.6.3.2.txt[1.6.3.2],
340 link:RelNotes/1.6.3.1.txt[1.6.3.1],
341 link:RelNotes/1.6.3.txt[1.6.3].
344 link:RelNotes/1.6.2.5.txt[1.6.2.5],
345 link:RelNotes/1.6.2.4.txt[1.6.2.4],
346 link:RelNotes/1.6.2.3.txt[1.6.2.3],
347 link:RelNotes/1.6.2.2.txt[1.6.2.2],
348 link:RelNotes/1.6.2.1.txt[1.6.2.1],
349 link:RelNotes/1.6.2.txt[1.6.2].
351 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
354 link:RelNotes/1.6.1.3.txt[1.6.1.3],
355 link:RelNotes/1.6.1.2.txt[1.6.1.2],
356 link:RelNotes/1.6.1.1.txt[1.6.1.1],
357 link:RelNotes/1.6.1.txt[1.6.1].
359 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
362 link:RelNotes/1.6.0.6.txt[1.6.0.6],
363 link:RelNotes/1.6.0.5.txt[1.6.0.5],
364 link:RelNotes/1.6.0.4.txt[1.6.0.4],
365 link:RelNotes/1.6.0.3.txt[1.6.0.3],
366 link:RelNotes/1.6.0.2.txt[1.6.0.2],
367 link:RelNotes/1.6.0.1.txt[1.6.0.1],
368 link:RelNotes/1.6.0.txt[1.6.0].
370 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
373 link:RelNotes/1.5.6.6.txt[1.5.6.6],
374 link:RelNotes/1.5.6.5.txt[1.5.6.5],
375 link:RelNotes/1.5.6.4.txt[1.5.6.4],
376 link:RelNotes/1.5.6.3.txt[1.5.6.3],
377 link:RelNotes/1.5.6.2.txt[1.5.6.2],
378 link:RelNotes/1.5.6.1.txt[1.5.6.1],
379 link:RelNotes/1.5.6.txt[1.5.6].
381 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
384 link:RelNotes/1.5.5.6.txt[1.5.5.6],
385 link:RelNotes/1.5.5.5.txt[1.5.5.5],
386 link:RelNotes/1.5.5.4.txt[1.5.5.4],
387 link:RelNotes/1.5.5.3.txt[1.5.5.3],
388 link:RelNotes/1.5.5.2.txt[1.5.5.2],
389 link:RelNotes/1.5.5.1.txt[1.5.5.1],
390 link:RelNotes/1.5.5.txt[1.5.5].
392 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
395 link:RelNotes/1.5.4.7.txt[1.5.4.7],
396 link:RelNotes/1.5.4.6.txt[1.5.4.6],
397 link:RelNotes/1.5.4.5.txt[1.5.4.5],
398 link:RelNotes/1.5.4.4.txt[1.5.4.4],
399 link:RelNotes/1.5.4.3.txt[1.5.4.3],
400 link:RelNotes/1.5.4.2.txt[1.5.4.2],
401 link:RelNotes/1.5.4.1.txt[1.5.4.1],
402 link:RelNotes/1.5.4.txt[1.5.4].
404 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
407 link:RelNotes/1.5.3.8.txt[1.5.3.8],
408 link:RelNotes/1.5.3.7.txt[1.5.3.7],
409 link:RelNotes/1.5.3.6.txt[1.5.3.6],
410 link:RelNotes/1.5.3.5.txt[1.5.3.5],
411 link:RelNotes/1.5.3.4.txt[1.5.3.4],
412 link:RelNotes/1.5.3.3.txt[1.5.3.3],
413 link:RelNotes/1.5.3.2.txt[1.5.3.2],
414 link:RelNotes/1.5.3.1.txt[1.5.3.1],
415 link:RelNotes/1.5.3.txt[1.5.3].
417 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
420 link:RelNotes/1.5.2.5.txt[1.5.2.5],
421 link:RelNotes/1.5.2.4.txt[1.5.2.4],
422 link:RelNotes/1.5.2.3.txt[1.5.2.3],
423 link:RelNotes/1.5.2.2.txt[1.5.2.2],
424 link:RelNotes/1.5.2.1.txt[1.5.2.1],
425 link:RelNotes/1.5.2.txt[1.5.2].
427 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
430 link:RelNotes/1.5.1.6.txt[1.5.1.6],
431 link:RelNotes/1.5.1.5.txt[1.5.1.5],
432 link:RelNotes/1.5.1.4.txt[1.5.1.4],
433 link:RelNotes/1.5.1.3.txt[1.5.1.3],
434 link:RelNotes/1.5.1.2.txt[1.5.1.2],
435 link:RelNotes/1.5.1.1.txt[1.5.1.1],
436 link:RelNotes/1.5.1.txt[1.5.1].
438 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
441 link:RelNotes/1.5.0.7.txt[1.5.0.7],
442 link:RelNotes/1.5.0.6.txt[1.5.0.6],
443 link:RelNotes/1.5.0.5.txt[1.5.0.5],
444 link:RelNotes/1.5.0.3.txt[1.5.0.3],
445 link:RelNotes/1.5.0.2.txt[1.5.0.2],
446 link:RelNotes/1.5.0.1.txt[1.5.0.1],
447 link:RelNotes/1.5.0.txt[1.5.0].
449 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
450 link:v1.3.3/git.html[1.3.3],
451 link:v1.2.6/git.html[1.2.6],
452 link:v1.0.13/git.html[1.0.13].
461 Prints the Git suite version that the 'git' program came from.
464 Prints the synopsis and a list of the most commonly used
465 commands. If the option '--all' or '-a' is given then all
466 available commands are printed. If a Git command is named this
467 option will bring up the manual page for that command.
469 Other options are available to control how the manual page is
470 displayed. See linkgit:git-help[1] for more information,
471 because `git --help ...` is converted internally into `git
475 Run as if git was started in '<path>' instead of the current working
476 directory. When multiple `-C` options are given, each subsequent
477 non-absolute `-C <path>` is interpreted relative to the preceding `-C
480 This option affects options that expect path name like `--git-dir` and
481 `--work-tree` in that their interpretations of the path names would be
482 made relative to the working directory caused by the `-C` option. For
483 example the following invocations are equivalent:
485 git --git-dir=a.git --work-tree=b -C c status
486 git --git-dir=c/a.git --work-tree=c/b status
489 Pass a configuration parameter to the command. The value
490 given will override values from configuration files.
491 The <name> is expected in the same format as listed by
492 'git config' (subkeys separated by dots).
494 Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
495 `foo.bar` to the boolean true value (just like `[foo]bar` would in a
496 config file). Including the equals but with an empty value (like `git -c
497 foo.bar= ...`) sets `foo.bar` to the empty string.
499 --exec-path[=<path>]::
500 Path to wherever your core Git programs are installed.
501 This can also be controlled by setting the GIT_EXEC_PATH
502 environment variable. If no path is given, 'git' will print
503 the current setting and then exit.
506 Print the path, without trailing slash, where Git's HTML
507 documentation is installed and exit.
510 Print the manpath (see `man(1)`) for the man pages for
511 this version of Git and exit.
514 Print the path where the Info files documenting this
515 version of Git are installed and exit.
519 Pipe all output into 'less' (or if set, $PAGER) if standard
520 output is a terminal. This overrides the `pager.<cmd>`
521 configuration options (see the "Configuration Mechanism" section
525 Do not pipe Git output into a pager.
528 Set the path to the repository. This can also be controlled by
529 setting the GIT_DIR environment variable. It can be an absolute
530 path or relative path to current working directory.
533 Set the path to the working tree. It can be an absolute path
534 or a path relative to the current working directory.
535 This can also be controlled by setting the GIT_WORK_TREE
536 environment variable and the core.worktree configuration
537 variable (see core.worktree in linkgit:git-config[1] for a
538 more detailed discussion).
541 Set the Git namespace. See linkgit:gitnamespaces[7] for more
542 details. Equivalent to setting the `GIT_NAMESPACE` environment
546 Treat the repository as a bare repository. If GIT_DIR
547 environment is not set, it is set to the current working
550 --no-replace-objects::
551 Do not use replacement refs to replace Git objects. See
552 linkgit:git-replace[1] for more information.
554 --literal-pathspecs::
555 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
556 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
560 Add "glob" magic to all pathspec. This is equivalent to setting
561 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
562 globbing on individual pathspecs can be done using pathspec
566 Add "literal" magic to all pathspec. This is equivalent to setting
567 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
568 globbing on individual pathspecs can be done using pathspec
572 Add "icase" magic to all pathspec. This is equivalent to setting
573 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
578 We divide Git into high level ("porcelain") commands and low level
579 ("plumbing") commands.
581 High-level commands (porcelain)
582 -------------------------------
584 We separate the porcelain commands into the main commands and some
585 ancillary user utilities.
587 Main porcelain commands
588 ~~~~~~~~~~~~~~~~~~~~~~~
590 include::cmds-mainporcelain.txt[]
596 include::cmds-ancillarymanipulators.txt[]
600 include::cmds-ancillaryinterrogators.txt[]
603 Interacting with Others
604 ~~~~~~~~~~~~~~~~~~~~~~~
606 These commands are to interact with foreign SCM and with other
607 people via patch over e-mail.
609 include::cmds-foreignscminterface.txt[]
612 Low-level commands (plumbing)
613 -----------------------------
615 Although Git includes its
616 own porcelain layer, its low-level commands are sufficient to support
617 development of alternative porcelains. Developers of such porcelains
618 might start by reading about linkgit:git-update-index[1] and
619 linkgit:git-read-tree[1].
621 The interface (input, output, set of options and the semantics)
622 to these low-level commands are meant to be a lot more stable
623 than Porcelain level commands, because these commands are
624 primarily for scripted use. The interface to Porcelain commands
625 on the other hand are subject to change in order to improve the
628 The following description divides
629 the low-level commands into commands that manipulate objects (in
630 the repository, index, and working tree), commands that interrogate and
631 compare objects, and commands that move objects and references between
635 Manipulation commands
636 ~~~~~~~~~~~~~~~~~~~~~
638 include::cmds-plumbingmanipulators.txt[]
641 Interrogation commands
642 ~~~~~~~~~~~~~~~~~~~~~~
644 include::cmds-plumbinginterrogators.txt[]
646 In general, the interrogate commands do not touch the files in
650 Synching repositories
651 ~~~~~~~~~~~~~~~~~~~~~
653 include::cmds-synchingrepositories.txt[]
655 The following are helper commands used by the above; end users
656 typically do not use them directly.
658 include::cmds-synchelpers.txt[]
661 Internal helper commands
662 ~~~~~~~~~~~~~~~~~~~~~~~~
664 These are internal helper commands used by other commands; end
665 users typically do not use them directly.
667 include::cmds-purehelpers.txt[]
670 Configuration Mechanism
671 -----------------------
673 Git uses a simple text format to store customizations that are per
674 repository and are per user. Such a configuration file may look
679 # A '#' or ';' character indicates a comment.
684 ; Don't trust file modes
689 name = "Junio C Hamano"
690 email = "gitster@pobox.com"
694 Various commands read from the configuration file and adjust
695 their operation accordingly. See linkgit:git-config[1] for a
696 list and more details about the configuration mechanism.
699 Identifier Terminology
700 ----------------------
702 Indicates the object name for any type of object.
705 Indicates a blob object name.
708 Indicates a tree object name.
711 Indicates a commit object name.
714 Indicates a tree, commit or tag object name. A
715 command that takes a <tree-ish> argument ultimately wants to
716 operate on a <tree> object but automatically dereferences
717 <commit> and <tag> objects that point at a <tree>.
720 Indicates a commit or tag object name. A
721 command that takes a <commit-ish> argument ultimately wants to
722 operate on a <commit> object but automatically dereferences
723 <tag> objects that point at a <commit>.
726 Indicates that an object type is required.
727 Currently one of: `blob`, `tree`, `commit`, or `tag`.
730 Indicates a filename - almost always relative to the
731 root of the tree structure `GIT_INDEX_FILE` describes.
735 Any Git command accepting any <object> can also use the following
739 indicates the head of the current branch.
743 (i.e. a `refs/tags/<tag>` reference).
747 (i.e. a `refs/heads/<head>` reference).
749 For a more complete list of ways to spell object names, see
750 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
753 File/Directory Structure
754 ------------------------
756 Please see the linkgit:gitrepository-layout[5] document.
758 Read linkgit:githooks[5] for more details about each hook.
760 Higher level SCMs may provide and manage additional information in the
766 Please see linkgit:gitglossary[7].
769 Environment Variables
770 ---------------------
771 Various Git commands use the following environment variables:
775 These environment variables apply to 'all' core Git commands. Nb: it
776 is worth noting that they may be used/overridden by SCMS sitting above
777 Git so take care if using Cogito etc.
780 This environment allows the specification of an alternate
781 index file. If not specified, the default of `$GIT_DIR/index`
784 'GIT_INDEX_VERSION'::
785 This environment variable allows the specification of an index
786 version for new repositories. It won't affect existing index
787 files. By default index file version 2 or 3 is used. See
788 linkgit:git-update-index[1] for more information.
790 'GIT_OBJECT_DIRECTORY'::
791 If the object storage directory is specified via this
792 environment variable then the sha1 directories are created
793 underneath - otherwise the default `$GIT_DIR/objects`
796 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
797 Due to the immutable nature of Git objects, old objects can be
798 archived into shared, read-only directories. This variable
799 specifies a ":" separated (on Windows ";" separated) list
800 of Git object directories which can be used to search for Git
801 objects. New objects will not be written to these directories.
804 If the 'GIT_DIR' environment variable is set then it
805 specifies a path to use instead of the default `.git`
806 for the base of the repository.
807 The '--git-dir' command-line option also sets this value.
810 Set the path to the root of the working tree.
811 This can also be controlled by the '--work-tree' command-line
812 option and the core.worktree configuration variable.
815 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
816 The '--namespace' command-line option also sets this value.
818 'GIT_CEILING_DIRECTORIES'::
819 This should be a colon-separated list of absolute paths. If
820 set, it is a list of directories that Git should not chdir up
821 into while looking for a repository directory (useful for
822 excluding slow-loading network directories). It will not
823 exclude the current working directory or a GIT_DIR set on the
824 command line or in the environment. Normally, Git has to read
825 the entries in this list and resolve any symlink that
826 might be present in order to compare them with the current
827 directory. However, if even this access is slow, you
828 can add an empty entry to the list to tell Git that the
829 subsequent entries are not symlinks and needn't be resolved;
831 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
833 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
834 When run in a directory that does not have ".git" repository
835 directory, Git tries to find such a directory in the parent
836 directories to find the top of the working tree, but by default it
837 does not cross filesystem boundaries. This environment variable
838 can be set to true to tell Git not to stop at filesystem
839 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
840 an explicit repository directory set via 'GIT_DIR' or on the
844 If this variable is set to a path, non-worktree files that are
845 normally in $GIT_DIR will be taken from this path
846 instead. Worktree-specific files such as HEAD or index are
847 taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
848 linkgit:git-worktree[1] for
849 details. This variable has lower precedence than other path
850 variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
857 'GIT_COMMITTER_NAME'::
858 'GIT_COMMITTER_EMAIL'::
859 'GIT_COMMITTER_DATE'::
861 see linkgit:git-commit-tree[1]
866 Only valid setting is "--unified=??" or "-u??" to set the
867 number of context lines shown when a unified diff is created.
868 This takes precedence over any "-U" or "--unified" option
869 value passed on the Git diff command line.
871 'GIT_EXTERNAL_DIFF'::
872 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
873 program named by it is called, instead of the diff invocation
874 described above. For a path that is added, removed, or modified,
875 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
877 path old-file old-hex old-mode new-file new-hex new-mode
881 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
882 contents of <old|new>,
883 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
884 <old|new>-mode:: are the octal representation of the file modes.
886 The file parameters can point at the user's working file
887 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
888 when a new file is added), or a temporary file (e.g. `old-file` in the
889 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
890 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
892 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
895 For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,
896 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.
898 'GIT_DIFF_PATH_COUNTER'::
899 A 1-based counter incremented by one for every path.
901 'GIT_DIFF_PATH_TOTAL'::
902 The total number of paths.
906 'GIT_MERGE_VERBOSITY'::
907 A number controlling the amount of output shown by
908 the recursive merge strategy. Overrides merge.verbosity.
909 See linkgit:git-merge[1]
912 This environment variable overrides `$PAGER`. If it is set
913 to an empty string or to the value "cat", Git will not launch
914 a pager. See also the `core.pager` option in
915 linkgit:git-config[1].
918 This environment variable overrides `$EDITOR` and `$VISUAL`.
919 It is used by several Git commands when, on interactive mode,
920 an editor is to be launched. See also linkgit:git-var[1]
921 and the `core.editor` option in linkgit:git-config[1].
925 If either of these environment variables is set then 'git fetch'
926 and 'git push' will use the specified command instead of 'ssh'
927 when they need to connect to a remote system.
928 The command will be given exactly two or four arguments: the
929 'username@host' (or just 'host') from the URL and the shell
930 command to execute on that remote system, optionally preceded by
931 '-p' (literally) and the 'port' from the URL when it specifies
932 something other than the default SSH port.
934 `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
935 by the shell, which allows additional arguments to be included.
936 `$GIT_SSH` on the other hand must be just the path to a program
937 (which can be a wrapper shell script, if additional arguments are
940 Usually it is easier to configure any desired options through your
941 personal `.ssh/config` file. Please consult your ssh documentation
945 If this environment variable is set, then Git commands which need to
946 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
947 will call this program with a suitable prompt as command-line argument
948 and read the password from its STDOUT. See also the 'core.askPass'
949 option in linkgit:git-config[1].
951 'GIT_TERMINAL_PROMPT'::
952 If this environment variable is set to `0`, git will not prompt
953 on the terminal (e.g., when asking for HTTP authentication).
955 'GIT_CONFIG_NOSYSTEM'::
956 Whether to skip reading settings from the system-wide
957 `$(prefix)/etc/gitconfig` file. This environment variable can
958 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
959 predictable environment for a picky script, or you can set it
960 temporarily to avoid using a buggy `/etc/gitconfig` file while
961 waiting for someone with sufficient permissions to fix it.
964 If this environment variable is set to "1", then commands such
965 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
966 'git check-attr' and 'git check-ignore' will
967 force a flush of the output stream after each record have been
969 variable is set to "0", the output of these commands will be done
970 using completely buffered I/O. If this environment variable is
971 not set, Git will choose buffered or record-oriented flushing
972 based on whether stdout appears to be redirected to a file or not.
975 Enables general trace messages, e.g. alias expansion, built-in
976 command execution and external command execution.
978 If this variable is set to "1", "2" or "true" (comparison
979 is case insensitive), trace messages will be printed to
982 If the variable is set to an integer value greater than 2
983 and lower than 10 (strictly) then Git will interpret this
984 value as an open file descriptor and will try to write the
985 trace messages into this file descriptor.
987 Alternatively, if the variable is set to an absolute path
988 (starting with a '/' character), Git will interpret this
989 as a file path and will try to write the trace messages
992 Unsetting the variable, or setting it to empty, "0" or
993 "false" (case insensitive) disables trace messages.
995 'GIT_TRACE_PACK_ACCESS'::
996 Enables trace messages for all accesses to any packs. For each
997 access, the pack file name and an offset in the pack is
998 recorded. This may be helpful for troubleshooting some
999 pack-related performance problems.
1000 See 'GIT_TRACE' for available trace output options.
1002 'GIT_TRACE_PACKET'::
1003 Enables trace messages for all packets coming in or out of a
1004 given program. This can help with debugging object negotiation
1005 or other protocol issues. Tracing is turned off at a packet
1006 starting with "PACK".
1007 See 'GIT_TRACE' for available trace output options.
1009 'GIT_TRACE_PERFORMANCE'::
1010 Enables performance related trace messages, e.g. total execution
1011 time of each Git command.
1012 See 'GIT_TRACE' for available trace output options.
1015 Enables trace messages printing the .git, working tree and current
1016 working directory after Git has completed its setup phase.
1017 See 'GIT_TRACE' for available trace output options.
1019 'GIT_TRACE_SHALLOW'::
1020 Enables trace messages that can help debugging fetching /
1021 cloning of shallow repositories.
1022 See 'GIT_TRACE' for available trace output options.
1024 GIT_LITERAL_PATHSPECS::
1025 Setting this variable to `1` will cause Git to treat all
1026 pathspecs literally, rather than as glob patterns. For example,
1027 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
1028 for commits that touch the path `*.c`, not any paths that the
1029 glob `*.c` matches. You might want this if you are feeding
1030 literal paths to Git (e.g., paths previously given to you by
1031 `git ls-tree`, `--raw` diff output, etc).
1033 GIT_GLOB_PATHSPECS::
1034 Setting this variable to `1` will cause Git to treat all
1035 pathspecs as glob patterns (aka "glob" magic).
1037 GIT_NOGLOB_PATHSPECS::
1038 Setting this variable to `1` will cause Git to treat all
1039 pathspecs as literal (aka "literal" magic).
1041 GIT_ICASE_PATHSPECS::
1042 Setting this variable to `1` will cause Git to treat all
1043 pathspecs as case-insensitive.
1045 'GIT_REFLOG_ACTION'::
1046 When a ref is updated, reflog entries are created to keep
1047 track of the reason why the ref was updated (which is
1048 typically the name of the high-level command that updated
1049 the ref), in addition to the old and new values of the ref.
1050 A scripted Porcelain command can use set_reflog_action
1051 helper function in `git-sh-setup` to set its name to this
1052 variable when it is invoked as the top level command by the
1053 end user, to be recorded in the body of the reflog.
1055 `GIT_REF_PARANOIA`::
1056 If set to `1`, include broken or badly named refs when iterating
1057 over lists of refs. In a normal, non-corrupted repository, this
1058 does nothing. However, enabling it may help git to detect and
1059 abort some operations in the presence of broken refs. Git sets
1060 this variable automatically when performing destructive
1061 operations like linkgit:git-prune[1]. You should not need to set
1062 it yourself unless you want to be paranoid about making sure
1063 an operation has touched every ref (e.g., because you are
1064 cloning a repository to make a backup).
1067 Discussion[[Discussion]]
1068 ------------------------
1070 More detail on the following is available from the
1071 link:user-manual.html#git-concepts[Git concepts chapter of the
1072 user-manual] and linkgit:gitcore-tutorial[7].
1074 A Git project normally consists of a working directory with a ".git"
1075 subdirectory at the top level. The .git directory contains, among other
1076 things, a compressed object database representing the complete history
1077 of the project, an "index" file which links that history to the current
1078 contents of the working tree, and named pointers into that history such
1079 as tags and branch heads.
1081 The object database contains objects of three main types: blobs, which
1082 hold file data; trees, which point to blobs and other trees to build up
1083 directory hierarchies; and commits, which each reference a single tree
1084 and some number of parent commits.
1086 The commit, equivalent to what other systems call a "changeset" or
1087 "version", represents a step in the project's history, and each parent
1088 represents an immediately preceding step. Commits with more than one
1089 parent represent merges of independent lines of development.
1091 All objects are named by the SHA-1 hash of their contents, normally
1092 written as a string of 40 hex digits. Such names are globally unique.
1093 The entire history leading up to a commit can be vouched for by signing
1094 just that commit. A fourth object type, the tag, is provided for this
1097 When first created, objects are stored in individual files, but for
1098 efficiency may later be compressed together into "pack files".
1100 Named pointers called refs mark interesting points in history. A ref
1101 may contain the SHA-1 name of an object or the name of another ref. Refs
1102 with names beginning `ref/head/` contain the SHA-1 name of the most
1103 recent commit (or "head") of a branch under development. SHA-1 names of
1104 tags of interest are stored under `ref/tags/`. A special ref named
1105 `HEAD` contains the name of the currently checked-out branch.
1107 The index file is initialized with a list of all paths and, for each
1108 path, a blob object and a set of attributes. The blob object represents
1109 the contents of the file as of the head of the current branch. The
1110 attributes (last modified time, size, etc.) are taken from the
1111 corresponding file in the working tree. Subsequent changes to the
1112 working tree can be found by comparing these attributes. The index may
1113 be updated with new content, and new commits may be created from the
1114 content stored in the index.
1116 The index is also capable of storing multiple entries (called "stages")
1117 for a given pathname. These stages are used to hold the various
1118 unmerged version of a file when a merge is in progress.
1120 FURTHER DOCUMENTATION
1121 ---------------------
1123 See the references in the "description" section to get started
1124 using Git. The following is probably more detail than necessary
1125 for a first-time user.
1127 The link:user-manual.html#git-concepts[Git concepts chapter of the
1128 user-manual] and linkgit:gitcore-tutorial[7] both provide
1129 introductions to the underlying Git architecture.
1131 See linkgit:gitworkflows[7] for an overview of recommended workflows.
1133 See also the link:howto-index.html[howto] documents for some useful
1136 The internals are documented in the
1137 link:technical/api-index.html[Git API documentation].
1139 Users migrating from CVS may also want to
1140 read linkgit:gitcvs-migration[7].
1145 Git was started by Linus Torvalds, and is currently maintained by Junio
1146 C Hamano. Numerous contributions have come from the Git mailing list
1147 <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
1148 gives you a more complete list of contributors.
1150 If you have a clone of git.git itself, the
1151 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1152 the authors for specific parts of the project.
1157 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1158 development and maintenance is primarily done. You do not have to be
1159 subscribed to the list to send a message there.
1163 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1164 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1165 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1166 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1167 linkgit:gitworkflows[7]
1171 Part of the linkgit:git[1] suite