]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git.txt
Merge branch 'jk/complete-commit-c' into maint
[thirdparty/git.git] / Documentation / git.txt
CommitLineData
9e1f0a85 1git(1)
2cf565c5 2======
2cf565c5
DG
3
4NAME
5----
6git - the stupid content tracker
7
8
9SYNOPSIS
10--------
8b70004b 11[verse]
68e4b552
ZJS
12'git' [--version] [--help] [-c <name>=<value>]
13 [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
d49483f0
JT
14 [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
15 [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
68e4b552 16 <command> [<args>]
2cf565c5
DG
17
18DESCRIPTION
19-----------
23091e95
BF
20Git is a fast, scalable, distributed revision control system with an
21unusually rich command set that provides both high-level operations
22and full access to internals.
23
6998e4db 24See linkgit:gittutorial[7] to get started, then see
7687ae98
JH
25link:everyday.html[Everyday Git] for a useful minimum set of
26commands. The link:user-manual.html[Git User's Manual] has a more
27in-depth introduction.
cb22bc44 28
7687ae98
JH
29After you mastered the basic concepts, you can come back to this
30page to learn what commands git offers. You can learn more about
31individual git commands with "git help command". linkgit:gitcli[7]
32manual page gives you an overview of the command line command syntax.
4514ad4f 33
7687ae98
JH
34Formatted and hyperlinked version of the latest git documentation
35can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
34b604af 36
26cfcfbf
JH
37ifdef::stalenotes[]
38[NOTE]
39============
26cfcfbf 40
2ff3f61a
JH
41You are reading the documentation for the latest (possibly
42unreleased) version of git, that is available from 'master'
43branch of the `git.git` repository.
44Documentation for older releases are available here:
43a8e4fe 45
5d417842
JH
46* link:v1.8.1/git.html[documentation for release 1.8.1]
47
48* release notes for
49 link:RelNotes/1.8.1.txt[1.8.1].
50
15999998 51* link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
8c7a786b
JH
52
53* release notes for
15999998 54 link:RelNotes/1.8.0.3.txt[1.8.0.3],
3e53891f 55 link:RelNotes/1.8.0.2.txt[1.8.0.2],
ed9fe755
JH
56 link:RelNotes/1.8.0.1.txt[1.8.0.1],
57 link:RelNotes/1.8.0.txt[1.8.0].
8c7a786b 58
7e201053 59* link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
889d3589
JH
60
61* release notes for
7e201053 62 link:RelNotes/1.7.12.4.txt[1.7.12.4],
234cd456 63 link:RelNotes/1.7.12.3.txt[1.7.12.3],
d8cf053d 64 link:RelNotes/1.7.12.2.txt[1.7.12.2],
304b7d99 65 link:RelNotes/1.7.12.1.txt[1.7.12.1],
889d3589
JH
66 link:RelNotes/1.7.12.txt[1.7.12].
67
bafc478f 68* link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
0ce2e396
JH
69
70* release notes for
bafc478f 71 link:RelNotes/1.7.11.7.txt[1.7.11.7],
e09e4024 72 link:RelNotes/1.7.11.6.txt[1.7.11.6],
cd7c0be1 73 link:RelNotes/1.7.11.5.txt[1.7.11.5],
0e4c8822 74 link:RelNotes/1.7.11.4.txt[1.7.11.4],
e6dfbcf1 75 link:RelNotes/1.7.11.3.txt[1.7.11.3],
8d141a1d 76 link:RelNotes/1.7.11.2.txt[1.7.11.2],
0e64a95a 77 link:RelNotes/1.7.11.1.txt[1.7.11.1],
0ce2e396
JH
78 link:RelNotes/1.7.11.txt[1.7.11].
79
785ee496 80* link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
e8dde3e5
JH
81
82* release notes for
785ee496 83 link:RelNotes/1.7.10.5.txt[1.7.10.5],
121f71f0 84 link:RelNotes/1.7.10.4.txt[1.7.10.4],
6a6d72b1 85 link:RelNotes/1.7.10.3.txt[1.7.10.3],
b6555d73 86 link:RelNotes/1.7.10.2.txt[1.7.10.2],
bf505158 87 link:RelNotes/1.7.10.1.txt[1.7.10.1],
e8dde3e5
JH
88 link:RelNotes/1.7.10.txt[1.7.10].
89
d0f1ea60 90* link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
828ea97d
JH
91
92* release notes for
d0f1ea60 93 link:RelNotes/1.7.9.7.txt[1.7.9.7],
cb2ed324 94 link:RelNotes/1.7.9.6.txt[1.7.9.6],
8ced9c90 95 link:RelNotes/1.7.9.5.txt[1.7.9.5],
a4603481 96 link:RelNotes/1.7.9.4.txt[1.7.9.4],
69f4e08f 97 link:RelNotes/1.7.9.3.txt[1.7.9.3],
78f4c9f6 98 link:RelNotes/1.7.9.2.txt[1.7.9.2],
90020e3b 99 link:RelNotes/1.7.9.1.txt[1.7.9.1],
828ea97d
JH
100 link:RelNotes/1.7.9.txt[1.7.9].
101
d9f5ef7a 102* link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
406da780
JH
103
104* release notes for
d9f5ef7a 105 link:RelNotes/1.7.8.6.txt[1.7.8.6],
cb2ed324 106 link:RelNotes/1.7.8.5.txt[1.7.8.5],
c572f491 107 link:RelNotes/1.7.8.4.txt[1.7.8.4],
5f4d133f
JH
108 link:RelNotes/1.7.8.3.txt[1.7.8.3],
109 link:RelNotes/1.7.8.2.txt[1.7.8.2],
110 link:RelNotes/1.7.8.1.txt[1.7.8.1],
406da780
JH
111 link:RelNotes/1.7.8.txt[1.7.8].
112
82588584 113* link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
703f05ad
JH
114
115* release notes for
82588584 116 link:RelNotes/1.7.7.7.txt[1.7.7.7],
c572f491 117 link:RelNotes/1.7.7.6.txt[1.7.7.6],
66c11f02
JH
118 link:RelNotes/1.7.7.5.txt[1.7.7.5],
119 link:RelNotes/1.7.7.4.txt[1.7.7.4],
120 link:RelNotes/1.7.7.3.txt[1.7.7.3],
121 link:RelNotes/1.7.7.2.txt[1.7.7.2],
f7d958df 122 link:RelNotes/1.7.7.1.txt[1.7.7.1],
703f05ad
JH
123 link:RelNotes/1.7.7.txt[1.7.7].
124
f174a258 125* link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
f696543d
JH
126
127* release notes for
f174a258 128 link:RelNotes/1.7.6.6.txt[1.7.6.6],
15b7898c 129 link:RelNotes/1.7.6.5.txt[1.7.6.5],
63205264 130 link:RelNotes/1.7.6.4.txt[1.7.6.4],
740a8fc2 131 link:RelNotes/1.7.6.3.txt[1.7.6.3],
509d5970
JH
132 link:RelNotes/1.7.6.2.txt[1.7.6.2],
133 link:RelNotes/1.7.6.1.txt[1.7.6.1],
f696543d
JH
134 link:RelNotes/1.7.6.txt[1.7.6].
135
e5af0de2 136* link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
ec014eac
JH
137
138* release notes for
e5af0de2 139 link:RelNotes/1.7.5.4.txt[1.7.5.4],
3c3e0b3c 140 link:RelNotes/1.7.5.3.txt[1.7.5.3],
3d5ae435 141 link:RelNotes/1.7.5.2.txt[1.7.5.2],
2f312e88 142 link:RelNotes/1.7.5.1.txt[1.7.5.1],
ec014eac
JH
143 link:RelNotes/1.7.5.txt[1.7.5].
144
6ceb270c 145* link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
7ed863a8
JH
146
147* release notes for
6ceb270c 148 link:RelNotes/1.7.4.5.txt[1.7.4.5],
6be05591 149 link:RelNotes/1.7.4.4.txt[1.7.4.4],
cb35c064
JH
150 link:RelNotes/1.7.4.3.txt[1.7.4.3],
151 link:RelNotes/1.7.4.2.txt[1.7.4.2],
9971d6d5 152 link:RelNotes/1.7.4.1.txt[1.7.4.1],
7ed863a8
JH
153 link:RelNotes/1.7.4.txt[1.7.4].
154
685e9d91 155* link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
87b50542
JH
156
157* release notes for
685e9d91 158 link:RelNotes/1.7.3.5.txt[1.7.3.5],
15368e18 159 link:RelNotes/1.7.3.4.txt[1.7.3.4],
ed94cc76 160 link:RelNotes/1.7.3.3.txt[1.7.3.3],
8a904385 161 link:RelNotes/1.7.3.2.txt[1.7.3.2],
92c1e717 162 link:RelNotes/1.7.3.1.txt[1.7.3.1],
87b50542
JH
163 link:RelNotes/1.7.3.txt[1.7.3].
164
1b974346 165* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
64fdc08d
JH
166
167* release notes for
1b974346 168 link:RelNotes/1.7.2.5.txt[1.7.2.5],
ed94cc76 169 link:RelNotes/1.7.2.4.txt[1.7.2.4],
761e742d
NP
170 link:RelNotes/1.7.2.3.txt[1.7.2.3],
171 link:RelNotes/1.7.2.2.txt[1.7.2.2],
172 link:RelNotes/1.7.2.1.txt[1.7.2.1],
173 link:RelNotes/1.7.2.txt[1.7.2].
64fdc08d 174
1b974346 175* link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
d599e048
JH
176
177* release notes for
1b974346 178 link:RelNotes/1.7.1.4.txt[1.7.1.4],
ed94cc76 179 link:RelNotes/1.7.1.3.txt[1.7.1.3],
761e742d
NP
180 link:RelNotes/1.7.1.2.txt[1.7.1.2],
181 link:RelNotes/1.7.1.1.txt[1.7.1.1],
182 link:RelNotes/1.7.1.txt[1.7.1].
d599e048 183
1b974346 184* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
e923eaeb
JH
185
186* release notes for
1b974346 187 link:RelNotes/1.7.0.9.txt[1.7.0.9],
ed94cc76 188 link:RelNotes/1.7.0.8.txt[1.7.0.8],
761e742d
NP
189 link:RelNotes/1.7.0.7.txt[1.7.0.7],
190 link:RelNotes/1.7.0.6.txt[1.7.0.6],
191 link:RelNotes/1.7.0.5.txt[1.7.0.5],
192 link:RelNotes/1.7.0.4.txt[1.7.0.4],
193 link:RelNotes/1.7.0.3.txt[1.7.0.3],
194 link:RelNotes/1.7.0.2.txt[1.7.0.2],
195 link:RelNotes/1.7.0.1.txt[1.7.0.1],
196 link:RelNotes/1.7.0.txt[1.7.0].
e923eaeb 197
1b974346 198* link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
902f2353
JH
199
200* release notes for
1b974346 201 link:RelNotes/1.6.6.3.txt[1.6.6.3],
761e742d
NP
202 link:RelNotes/1.6.6.2.txt[1.6.6.2],
203 link:RelNotes/1.6.6.1.txt[1.6.6.1],
204 link:RelNotes/1.6.6.txt[1.6.6].
902f2353 205
1b974346 206* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
78d553b7
JH
207
208* release notes for
1b974346 209 link:RelNotes/1.6.5.9.txt[1.6.5.9],
761e742d
NP
210 link:RelNotes/1.6.5.8.txt[1.6.5.8],
211 link:RelNotes/1.6.5.7.txt[1.6.5.7],
212 link:RelNotes/1.6.5.6.txt[1.6.5.6],
213 link:RelNotes/1.6.5.5.txt[1.6.5.5],
214 link:RelNotes/1.6.5.4.txt[1.6.5.4],
215 link:RelNotes/1.6.5.3.txt[1.6.5.3],
216 link:RelNotes/1.6.5.2.txt[1.6.5.2],
217 link:RelNotes/1.6.5.1.txt[1.6.5.1],
218 link:RelNotes/1.6.5.txt[1.6.5].
78d553b7 219
1b974346 220* link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
0a53e9dd
JH
221
222* release notes for
1b974346 223 link:RelNotes/1.6.4.5.txt[1.6.4.5],
761e742d
NP
224 link:RelNotes/1.6.4.4.txt[1.6.4.4],
225 link:RelNotes/1.6.4.3.txt[1.6.4.3],
226 link:RelNotes/1.6.4.2.txt[1.6.4.2],
227 link:RelNotes/1.6.4.1.txt[1.6.4.1],
228 link:RelNotes/1.6.4.txt[1.6.4].
0a53e9dd 229
441b40d8 230* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
6096d759
JH
231
232* release notes for
761e742d
NP
233 link:RelNotes/1.6.3.4.txt[1.6.3.4],
234 link:RelNotes/1.6.3.3.txt[1.6.3.3],
235 link:RelNotes/1.6.3.2.txt[1.6.3.2],
236 link:RelNotes/1.6.3.1.txt[1.6.3.1],
237 link:RelNotes/1.6.3.txt[1.6.3].
a95148de
JH
238
239* release notes for
761e742d
NP
240 link:RelNotes/1.6.2.5.txt[1.6.2.5],
241 link:RelNotes/1.6.2.4.txt[1.6.2.4],
242 link:RelNotes/1.6.2.3.txt[1.6.2.3],
243 link:RelNotes/1.6.2.2.txt[1.6.2.2],
244 link:RelNotes/1.6.2.1.txt[1.6.2.1],
245 link:RelNotes/1.6.2.txt[1.6.2].
a95148de 246
621f1b4b 247* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
8104ebfe
JH
248
249* release notes for
761e742d
NP
250 link:RelNotes/1.6.1.3.txt[1.6.1.3],
251 link:RelNotes/1.6.1.2.txt[1.6.1.2],
252 link:RelNotes/1.6.1.1.txt[1.6.1.1],
253 link:RelNotes/1.6.1.txt[1.6.1].
8104ebfe 254
efe05b01 255* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
ea02eef0
JH
256
257* release notes for
761e742d
NP
258 link:RelNotes/1.6.0.6.txt[1.6.0.6],
259 link:RelNotes/1.6.0.5.txt[1.6.0.5],
260 link:RelNotes/1.6.0.4.txt[1.6.0.4],
261 link:RelNotes/1.6.0.3.txt[1.6.0.3],
262 link:RelNotes/1.6.0.2.txt[1.6.0.2],
263 link:RelNotes/1.6.0.1.txt[1.6.0.1],
264 link:RelNotes/1.6.0.txt[1.6.0].
ea02eef0 265
efe05b01 266* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
e449f105
JH
267
268* release notes for
761e742d
NP
269 link:RelNotes/1.5.6.6.txt[1.5.6.6],
270 link:RelNotes/1.5.6.5.txt[1.5.6.5],
271 link:RelNotes/1.5.6.4.txt[1.5.6.4],
272 link:RelNotes/1.5.6.3.txt[1.5.6.3],
273 link:RelNotes/1.5.6.2.txt[1.5.6.2],
274 link:RelNotes/1.5.6.1.txt[1.5.6.1],
275 link:RelNotes/1.5.6.txt[1.5.6].
e449f105 276
efe05b01 277* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
1d2375dd
JH
278
279* release notes for
761e742d
NP
280 link:RelNotes/1.5.5.6.txt[1.5.5.6],
281 link:RelNotes/1.5.5.5.txt[1.5.5.5],
282 link:RelNotes/1.5.5.4.txt[1.5.5.4],
283 link:RelNotes/1.5.5.3.txt[1.5.5.3],
284 link:RelNotes/1.5.5.2.txt[1.5.5.2],
285 link:RelNotes/1.5.5.1.txt[1.5.5.1],
286 link:RelNotes/1.5.5.txt[1.5.5].
1d2375dd 287
efe05b01 288* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
6ce8e44a
JH
289
290* release notes for
761e742d
NP
291 link:RelNotes/1.5.4.7.txt[1.5.4.7],
292 link:RelNotes/1.5.4.6.txt[1.5.4.6],
293 link:RelNotes/1.5.4.5.txt[1.5.4.5],
294 link:RelNotes/1.5.4.4.txt[1.5.4.4],
295 link:RelNotes/1.5.4.3.txt[1.5.4.3],
296 link:RelNotes/1.5.4.2.txt[1.5.4.2],
297 link:RelNotes/1.5.4.1.txt[1.5.4.1],
298 link:RelNotes/1.5.4.txt[1.5.4].
6ce8e44a 299
e708af6e 300* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
5587cac2
JH
301
302* release notes for
761e742d
NP
303 link:RelNotes/1.5.3.8.txt[1.5.3.8],
304 link:RelNotes/1.5.3.7.txt[1.5.3.7],
305 link:RelNotes/1.5.3.6.txt[1.5.3.6],
306 link:RelNotes/1.5.3.5.txt[1.5.3.5],
307 link:RelNotes/1.5.3.4.txt[1.5.3.4],
308 link:RelNotes/1.5.3.3.txt[1.5.3.3],
309 link:RelNotes/1.5.3.2.txt[1.5.3.2],
310 link:RelNotes/1.5.3.1.txt[1.5.3.1],
311 link:RelNotes/1.5.3.txt[1.5.3].
b6e4db6a 312
e636106c
JH
313* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
314
aba170cd 315* release notes for
761e742d
NP
316 link:RelNotes/1.5.2.5.txt[1.5.2.5],
317 link:RelNotes/1.5.2.4.txt[1.5.2.4],
318 link:RelNotes/1.5.2.3.txt[1.5.2.3],
319 link:RelNotes/1.5.2.2.txt[1.5.2.2],
320 link:RelNotes/1.5.2.1.txt[1.5.2.1],
321 link:RelNotes/1.5.2.txt[1.5.2].
aba170cd
JH
322
323* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
324
325* release notes for
761e742d
NP
326 link:RelNotes/1.5.1.6.txt[1.5.1.6],
327 link:RelNotes/1.5.1.5.txt[1.5.1.5],
328 link:RelNotes/1.5.1.4.txt[1.5.1.4],
329 link:RelNotes/1.5.1.3.txt[1.5.1.3],
330 link:RelNotes/1.5.1.2.txt[1.5.1.2],
331 link:RelNotes/1.5.1.1.txt[1.5.1.1],
332 link:RelNotes/1.5.1.txt[1.5.1].
2ff3f61a
JH
333
334* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
335
aba170cd 336* release notes for
761e742d
NP
337 link:RelNotes/1.5.0.7.txt[1.5.0.7],
338 link:RelNotes/1.5.0.6.txt[1.5.0.6],
339 link:RelNotes/1.5.0.5.txt[1.5.0.5],
340 link:RelNotes/1.5.0.3.txt[1.5.0.3],
341 link:RelNotes/1.5.0.2.txt[1.5.0.2],
342 link:RelNotes/1.5.0.1.txt[1.5.0.1],
343 link:RelNotes/1.5.0.txt[1.5.0].
2ff3f61a
JH
344
345* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
346 link:v1.3.3/git.html[1.3.3],
347 link:v1.2.6/git.html[1.2.6],
348 link:v1.0.13/git.html[1.0.13].
26cfcfbf
JH
349
350============
351
352endif::stalenotes[]
353
cb22bc44
AE
354OPTIONS
355-------
356--version::
a87cd02c 357 Prints the git suite version that the 'git' program came from.
cb22bc44
AE
358
359--help::
a87cd02c 360 Prints the synopsis and a list of the most commonly used
0f6f195b
CC
361 commands. If the option '--all' or '-a' is given then all
362 available commands are printed. If a git command is named this
363 option will bring up the manual page for that command.
45533d26
CC
364+
365Other options are available to control how the manual page is
5162e697 366displayed. See linkgit:git-help[1] for more information,
db5d6666
JN
367because `git --help ...` is converted internally into `git
368help ...`.
cb22bc44 369
8b1fa778
AR
370-c <name>=<value>::
371 Pass a configuration parameter to the command. The value
372 given will override values from configuration files.
373 The <name> is expected in the same format as listed by
374 'git config' (subkeys separated by dots).
375
62b4698e 376--exec-path[=<path>]::
a87cd02c 377 Path to wherever your core git programs are installed.
cb22bc44 378 This can also be controlled by setting the GIT_EXEC_PATH
56992f76 379 environment variable. If no path is given, 'git' will print
cb22bc44
AE
380 the current setting and then exit.
381
89a56bfb 382--html-path::
239b5ed9
JN
383 Print the path, without trailing slash, where git's HTML
384 documentation is installed and exit.
89a56bfb 385
f2dd8c37 386--man-path::
239b5ed9
JN
387 Print the manpath (see `man(1)`) for the man pages for
388 this version of git and exit.
f2dd8c37
JS
389
390--info-path::
239b5ed9
JN
391 Print the path where the Info files documenting this
392 version of git are installed and exit.
89a56bfb 393
3240240f
SB
394-p::
395--paginate::
06300d97
JN
396 Pipe all output into 'less' (or if set, $PAGER) if standard
397 output is a terminal. This overrides the `pager.<cmd>`
398 configuration options (see the "Configuration Mechanism" section
399 below).
6acbcb92 400
463a849d
MM
401--no-pager::
402 Do not pipe git output into a pager.
403
6acbcb92
JS
404--git-dir=<path>::
405 Set the path to the repository. This can also be controlled by
302cc11a
LY
406 setting the GIT_DIR environment variable. It can be an absolute
407 path or relative path to current working directory.
6acbcb92 408
892c41b9 409--work-tree=<path>::
ea472c1e
JH
410 Set the path to the working tree. It can be an absolute path
411 or a path relative to the current working directory.
892c41b9
ML
412 This can also be controlled by setting the GIT_WORK_TREE
413 environment variable and the core.worktree configuration
ea472c1e
JH
414 variable (see core.worktree in linkgit:git-config[1] for a
415 more detailed discussion).
892c41b9 416
d49483f0
JT
417--namespace=<path>::
418 Set the git namespace. See linkgit:gitnamespaces[7] for more
419 details. Equivalent to setting the `GIT_NAMESPACE` environment
420 variable.
421
6acbcb92 422--bare::
9277d602
JH
423 Treat the repository as a bare repository. If GIT_DIR
424 environment is not set, it is set to the current working
425 directory.
426
b0fa7ab5
CC
427--no-replace-objects::
428 Do not use replacement refs to replace git objects. See
429 linkgit:git-replace[1] for more information.
430
9755afbd 431
23091e95
BF
432GIT COMMANDS
433------------
9755afbd 434
23091e95
BF
435We divide git into high level ("porcelain") commands and low level
436("plumbing") commands.
8b15e2fb 437
23091e95
BF
438High-level commands (porcelain)
439-------------------------------
440
441We separate the porcelain commands into the main commands and some
442ancillary user utilities.
443
444Main porcelain commands
445~~~~~~~~~~~~~~~~~~~~~~~
905197de 446
377e8139 447include::cmds-mainporcelain.txt[]
e31bb3bb 448
90933efb 449Ancillary Commands
23091e95 450~~~~~~~~~~~~~~~~~~
2f2de9b4
JH
451Manipulators:
452
377e8139 453include::cmds-ancillarymanipulators.txt[]
204ee6a9 454
90933efb 455Interrogators:
204ee6a9 456
377e8139 457include::cmds-ancillaryinterrogators.txt[]
7fc9d69f 458
89bf2077
JH
459
460Interacting with Others
461~~~~~~~~~~~~~~~~~~~~~~~
462
463These commands are to interact with foreign SCM and with other
464people via patch over e-mail.
465
466include::cmds-foreignscminterface.txt[]
467
468
b1f33d62
RR
469Low-level commands (plumbing)
470-----------------------------
471
472Although git includes its
473own porcelain layer, its low-level commands are sufficient to support
474development of alternative porcelains. Developers of such porcelains
5162e697
DM
475might start by reading about linkgit:git-update-index[1] and
476linkgit:git-read-tree[1].
b1f33d62 477
89bf2077
JH
478The interface (input, output, set of options and the semantics)
479to these low-level commands are meant to be a lot more stable
480than Porcelain level commands, because these commands are
481primarily for scripted use. The interface to Porcelain commands
482on the other hand are subject to change in order to improve the
483end user experience.
484
485The following description divides
486the low-level commands into commands that manipulate objects (in
b1f33d62
RR
487the repository, index, and working tree), commands that interrogate and
488compare objects, and commands that move objects and references between
489repositories.
490
89bf2077 491
b1f33d62
RR
492Manipulation commands
493~~~~~~~~~~~~~~~~~~~~~
b1f33d62 494
377e8139 495include::cmds-plumbingmanipulators.txt[]
b1f33d62
RR
496
497
498Interrogation commands
499~~~~~~~~~~~~~~~~~~~~~~
500
377e8139 501include::cmds-plumbinginterrogators.txt[]
b1f33d62
RR
502
503In general, the interrogate commands do not touch the files in
504the working tree.
505
506
507Synching repositories
508~~~~~~~~~~~~~~~~~~~~~
509
377e8139 510include::cmds-synchingrepositories.txt[]
b1f33d62 511
57f6ec02 512The following are helper commands used by the above; end users
89bf2077
JH
513typically do not use them directly.
514
515include::cmds-synchelpers.txt[]
516
517
518Internal helper commands
519~~~~~~~~~~~~~~~~~~~~~~~~
520
521These are internal helper commands used by other commands; end
522users typically do not use them directly.
523
524include::cmds-purehelpers.txt[]
525
b1f33d62 526
5773c9f2
JH
527Configuration Mechanism
528-----------------------
529
2fa090b6 530Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
5773c9f2 531is used to hold per-repository configuration options. It is a
addf88e4 532simple text file modeled after `.ini` format familiar to some
5773c9f2
JH
533people. Here is an example:
534
535------------
536#
2fa090b6 537# A '#' or ';' character indicates a comment.
5773c9f2
JH
538#
539
540; core variables
541[core]
542 ; Don't trust file modes
543 filemode = false
544
545; user identity
546[user]
547 name = "Junio C Hamano"
548 email = "junkio@twinsun.com"
549
550------------
551
552Various commands read from the configuration file and adjust
06300d97
JN
553their operation accordingly. See linkgit:git-config[1] for a
554list.
5773c9f2
JH
555
556
6c84e2e0 557Identifier Terminology
2cf565c5
DG
558----------------------
559<object>::
2fa090b6 560 Indicates the object name for any type of object.
2cf565c5
DG
561
562<blob>::
2fa090b6 563 Indicates a blob object name.
2cf565c5
DG
564
565<tree>::
2fa090b6 566 Indicates a tree object name.
2cf565c5
DG
567
568<commit>::
2fa090b6 569 Indicates a commit object name.
2cf565c5
DG
570
571<tree-ish>::
2fa090b6 572 Indicates a tree, commit or tag object name. A
6c84e2e0
DG
573 command that takes a <tree-ish> argument ultimately wants to
574 operate on a <tree> object but automatically dereferences
575 <commit> and <tag> objects that point at a <tree>.
2cf565c5 576
043d7605
TT
577<commit-ish>::
578 Indicates a commit or tag object name. A
579 command that takes a <commit-ish> argument ultimately wants to
580 operate on a <commit> object but automatically dereferences
581 <tag> objects that point at a <commit>.
582
2cf565c5
DG
583<type>::
584 Indicates that an object type is required.
2fa090b6 585 Currently one of: `blob`, `tree`, `commit`, or `tag`.
2cf565c5
DG
586
587<file>::
2fa090b6
JH
588 Indicates a filename - almost always relative to the
589 root of the tree structure `GIT_INDEX_FILE` describes.
2cf565c5 590
c1bdacf9
DG
591Symbolic Identifiers
592--------------------
90933efb 593Any git command accepting any <object> can also use the following
6c84e2e0 594symbolic notation:
c1bdacf9
DG
595
596HEAD::
0abcfbff 597 indicates the head of the current branch.
2fa090b6 598
c1bdacf9 599<tag>::
2fa090b6 600 a valid tag 'name'
0abcfbff 601 (i.e. a `refs/tags/<tag>` reference).
2fa090b6 602
c1bdacf9 603<head>::
2fa090b6 604 a valid head 'name'
0abcfbff 605 (i.e. a `refs/heads/<head>` reference).
2fa090b6 606
d47107d8 607For a more complete list of ways to spell object names, see
9d83e382 608"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
d47107d8 609
c1bdacf9
DG
610
611File/Directory Structure
612------------------------
c1bdacf9 613
6998e4db 614Please see the linkgit:gitrepository-layout[5] document.
c1bdacf9 615
6998e4db 616Read linkgit:githooks[5] for more details about each hook.
6250ad1e 617
c1bdacf9 618Higher level SCMs may provide and manage additional information in the
2fa090b6 619`$GIT_DIR`.
c1bdacf9 620
a1d4aa74 621
2cf565c5
DG
622Terminology
623-----------
6998e4db 624Please see linkgit:gitglossary[7].
2cf565c5
DG
625
626
627Environment Variables
628---------------------
629Various git commands use the following environment variables:
630
c1bdacf9
DG
631The git Repository
632~~~~~~~~~~~~~~~~~~
633These environment variables apply to 'all' core git commands. Nb: it
634is worth noting that they may be used/overridden by SCMS sitting above
2fa090b6 635git so take care if using Cogito etc.
c1bdacf9
DG
636
637'GIT_INDEX_FILE'::
638 This environment allows the specification of an alternate
5f3aa197
LS
639 index file. If not specified, the default of `$GIT_DIR/index`
640 is used.
c1bdacf9
DG
641
642'GIT_OBJECT_DIRECTORY'::
643 If the object storage directory is specified via this
644 environment variable then the sha1 directories are created
645 underneath - otherwise the default `$GIT_DIR/objects`
646 directory is used.
647
648'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
649 Due to the immutable nature of git objects, old objects can be
650 archived into shared, read-only directories. This variable
80ba074f
JS
651 specifies a ":" separated (on Windows ";" separated) list
652 of git object directories which can be used to search for git
653 objects. New objects will not be written to these directories.
c1bdacf9
DG
654
655'GIT_DIR'::
2fa090b6
JH
656 If the 'GIT_DIR' environment variable is set then it
657 specifies a path to use instead of the default `.git`
658 for the base of the repository.
75940a00 659 The '--git-dir' command-line option also sets this value.
c1bdacf9 660
892c41b9
ML
661'GIT_WORK_TREE'::
662 Set the path to the working tree. The value will not be
663 used in combination with repositories found automatically in
664 a .git directory (i.e. $GIT_DIR is not set).
665 This can also be controlled by the '--work-tree' command line
666 option and the core.worktree configuration variable.
667
d49483f0
JT
668'GIT_NAMESPACE'::
669 Set the git namespace; see linkgit:gitnamespaces[7] for details.
670 The '--namespace' command-line option also sets this value.
671
0454dd93
DR
672'GIT_CEILING_DIRECTORIES'::
673 This should be a colon-separated list of absolute paths.
674 If set, it is a list of directories that git should not chdir
675 up into while looking for a repository directory.
676 It will not exclude the current working directory or
677 a GIT_DIR set on the command line or in the environment.
678 (Useful for excluding slow-loading network directories.)
679
cf87463e 680'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
e6405517
JH
681 When run in a directory that does not have ".git" repository
682 directory, git tries to find such a directory in the parent
683 directories to find the top of the working tree, but by default it
684 does not cross filesystem boundaries. This environment variable
cf87463e
JH
685 can be set to true to tell git not to stop at filesystem
686 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
687 an explicit repository directory set via 'GIT_DIR' or on the
688 command line.
8030e442 689
c1bdacf9
DG
690git Commits
691~~~~~~~~~~~
692'GIT_AUTHOR_NAME'::
693'GIT_AUTHOR_EMAIL'::
694'GIT_AUTHOR_DATE'::
695'GIT_COMMITTER_NAME'::
696'GIT_COMMITTER_EMAIL'::
4e58bf97 697'GIT_COMMITTER_DATE'::
28a94f88 698'EMAIL'::
5162e697 699 see linkgit:git-commit-tree[1]
c1bdacf9
DG
700
701git Diffs
702~~~~~~~~~
d81ed1b5 703'GIT_DIFF_OPTS'::
fde97d8a
SE
704 Only valid setting is "--unified=??" or "-u??" to set the
705 number of context lines shown when a unified diff is created.
706 This takes precedence over any "-U" or "--unified" option
707 value passed on the git diff command line.
708
d81ed1b5 709'GIT_EXTERNAL_DIFF'::
fde97d8a
SE
710 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
711 program named by it is called, instead of the diff invocation
712 described above. For a path that is added, removed, or modified,
713 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
714
715 path old-file old-hex old-mode new-file new-hex new-mode
716+
717where:
718
719 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
720 contents of <old|new>,
721 <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
722 <old|new>-mode:: are the octal representation of the file modes.
fde97d8a
SE
723+
724The file parameters can point at the user's working file
725(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
726when a new file is added), or a temporary file (e.g. `old-file` in the
727index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
728temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
729+
730For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
731parameter, <path>.
2cf565c5 732
575ba9d6
ML
733other
734~~~~~
dbddb714
JN
735'GIT_MERGE_VERBOSITY'::
736 A number controlling the amount of output shown by
737 the recursive merge strategy. Overrides merge.verbosity.
5162e697 738 See linkgit:git-merge[1]
dbddb714 739
c27d205a 740'GIT_PAGER'::
a7738c77
SG
741 This environment variable overrides `$PAGER`. If it is set
742 to an empty string or to the value "cat", git will not launch
ab54cd6c
JN
743 a pager. See also the `core.pager` option in
744 linkgit:git-config[1].
c27d205a 745
36384c97
RSM
746'GIT_EDITOR'::
747 This environment variable overrides `$EDITOR` and `$VISUAL`.
b4ab1980 748 It is used by several git commands when, on interactive mode,
36384c97
RSM
749 an editor is to be launched. See also linkgit:git-var[1]
750 and the `core.editor` option in linkgit:git-config[1].
751
d5538b41 752'GIT_SSH'::
0b444cdb
TR
753 If this environment variable is set then 'git fetch'
754 and 'git push' will use this command instead
2fd02c92 755 of 'ssh' when they need to connect to a remote system.
483bc4f0 756 The '$GIT_SSH' command will be given exactly two arguments:
d5538b41
SP
757 the 'username@host' (or just 'host') from the URL and the
758 shell command to execute on that remote system.
759+
760To pass options to the program that you want to list in GIT_SSH
761you will need to wrap the program and options into a shell script,
762then set GIT_SSH to refer to the shell script.
763+
764Usually it is easier to configure any desired options through your
765personal `.ssh/config` file. Please consult your ssh documentation
766for further details.
767
453842c9
KF
768'GIT_ASKPASS'::
769 If this environment variable is set, then git commands which need to
770 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
771 will call this program with a suitable prompt as command line argument
772 and read the password from its STDOUT. See also the 'core.askpass'
773 option in linkgit:git-config[1].
774
e8ef401c
JN
775'GIT_CONFIG_NOSYSTEM'::
776 Whether to skip reading settings from the system-wide
777 `$(prefix)/etc/gitconfig` file. This environment variable can
778 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
779 predictable environment for a picky script, or you can set it
780 temporarily to avoid using a buggy `/etc/gitconfig` file while
781 waiting for someone with sufficient permissions to fix it.
782
06f59e9f
TT
783'GIT_FLUSH'::
784 If this environment variable is set to "1", then commands such
0b444cdb
TR
785 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
786 and 'git whatchanged' will force a flush of the output stream
06f59e9f
TT
787 after each commit-oriented record have been flushed. If this
788 variable is set to "0", the output of these commands will be done
789 using completely buffered I/O. If this environment variable is
790 not set, git will choose buffered or record-oriented flushing
791 based on whether stdout appears to be redirected to a file or not.
792
575ba9d6 793'GIT_TRACE'::
2886bdb1
CC
794 If this variable is set to "1", "2" or "true" (comparison
795 is case insensitive), git will print `trace:` messages on
575ba9d6
ML
796 stderr telling about alias expansion, built-in command
797 execution and external command execution.
2886bdb1
CC
798 If this variable is set to an integer value greater than 1
799 and lower than 10 (strictly) then git will interpret this
800 value as an open file descriptor and will try to write the
801 trace messages into this file descriptor.
802 Alternatively, if this variable is set to an absolute path
803 (starting with a '/' character), git will interpret this
804 as a file path and will try to write the trace messages
805 into it.
575ba9d6 806
8db9307c
JH
807Discussion[[Discussion]]
808------------------------
40dac517
BF
809
810More detail on the following is available from the
811link:user-manual.html#git-concepts[git concepts chapter of the
6998e4db 812user-manual] and linkgit:gitcore-tutorial[7].
40dac517
BF
813
814A git project normally consists of a working directory with a ".git"
815subdirectory at the top level. The .git directory contains, among other
816things, a compressed object database representing the complete history
817of the project, an "index" file which links that history to the current
818contents of the working tree, and named pointers into that history such
819as tags and branch heads.
820
821The object database contains objects of three main types: blobs, which
822hold file data; trees, which point to blobs and other trees to build up
02ff6250 823directory hierarchies; and commits, which each reference a single tree
40dac517
BF
824and some number of parent commits.
825
826The commit, equivalent to what other systems call a "changeset" or
827"version", represents a step in the project's history, and each parent
828represents an immediately preceding step. Commits with more than one
829parent represent merges of independent lines of development.
830
831All objects are named by the SHA1 hash of their contents, normally
832written as a string of 40 hex digits. Such names are globally unique.
833The entire history leading up to a commit can be vouched for by signing
834just that commit. A fourth object type, the tag, is provided for this
835purpose.
836
837When first created, objects are stored in individual files, but for
838efficiency may later be compressed together into "pack files".
839
840Named pointers called refs mark interesting points in history. A ref
841may contain the SHA1 name of an object or the name of another ref. Refs
842with names beginning `ref/head/` contain the SHA1 name of the most
02ff6250 843recent commit (or "head") of a branch under development. SHA1 names of
40dac517
BF
844tags of interest are stored under `ref/tags/`. A special ref named
845`HEAD` contains the name of the currently checked-out branch.
846
847The index file is initialized with a list of all paths and, for each
848path, a blob object and a set of attributes. The blob object represents
849the contents of the file as of the head of the current branch. The
850attributes (last modified time, size, etc.) are taken from the
851corresponding file in the working tree. Subsequent changes to the
852working tree can be found by comparing these attributes. The index may
853be updated with new content, and new commits may be created from the
854content stored in the index.
855
856The index is also capable of storing multiple entries (called "stages")
857for a given pathname. These stages are used to hold the various
858unmerged version of a file when a merge is in progress.
6c84e2e0 859
7687ae98
JH
860FURTHER DOCUMENTATION
861---------------------
862
863See the references in the "description" section to get started
864using git. The following is probably more detail than necessary
865for a first-time user.
866
867The link:user-manual.html#git-concepts[git concepts chapter of the
868user-manual] and linkgit:gitcore-tutorial[7] both provide
869introductions to the underlying git architecture.
870
871See linkgit:gitworkflows[7] for an overview of recommended workflows.
872
873See also the link:howto-index.html[howto] documents for some useful
874examples.
875
876The internals are documented in the
877link:technical/api-index.html[GIT API documentation].
878
879Users migrating from CVS may also want to
880read linkgit:gitcvs-migration[7].
881
882
cb22bc44
AE
883Authors
884-------
48bb914e
JK
885Git was started by Linus Torvalds, and is currently maintained by Junio
886C Hamano. Numerous contributions have come from the git mailing list
6ecc01f2
JH
887<git@vger.kernel.org>. http://www.ohloh.net/p/git/contributors/summary
888gives you a more complete list of contributors.
889
890If you have a clone of git.git itself, the
d8f708f8
JK
891output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
892the authors for specific parts of the project.
2cf565c5 893
c97ca277
JH
894Reporting Bugs
895--------------
896
897Report bugs to the Git mailing list <git@vger.kernel.org> where the
898development and maintenance is primarily done. You do not have to be
899subscribed to the list to send a message there.
900
497c8331
CC
901SEE ALSO
902--------
903linkgit:gittutorial[7], linkgit:gittutorial-2[7],
5cbef01a 904link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
497c8331 905linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
801a011d
TR
906linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
907linkgit:gitworkflows[7]
497c8331 908
2cf565c5
DG
909GIT
910---
9e1f0a85 911Part of the linkgit:git[1] suite