]>
Commit | Line | Data |
---|---|---|
9e1f0a85 | 1 | git(1) |
2cf565c5 | 2 | ====== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
6 | git - the stupid content tracker | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
8b70004b | 11 | [verse] |
44e1e4d6 | 12 | 'git' [--version] [--help] [-C <path>] [-c <name>=<value>] |
68e4b552 | 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 | |
18 | DESCRIPTION | |
19 | ----------- | |
23091e95 BF |
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. | |
23 | ||
6998e4db | 24 | See linkgit:gittutorial[7] to get started, then see |
673151a9 | 25 | linkgit:giteveryday[7] for a useful minimum set of |
7687ae98 JH |
26 | commands. The link:user-manual.html[Git User's Manual] has a more |
27 | in-depth introduction. | |
cb22bc44 | 28 | |
7687ae98 | 29 | After you mastered the basic concepts, you can come back to this |
2de9b711 TA |
30 | page to learn what commands Git offers. You can learn more about |
31 | individual Git commands with "git help command". linkgit:gitcli[7] | |
06ab60c0 | 32 | manual page gives you an overview of the command-line command syntax. |
4514ad4f | 33 | |
2de9b711 | 34 | Formatted and hyperlinked version of the latest Git documentation |
7687ae98 | 35 | can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`. |
34b604af | 36 | |
26cfcfbf JH |
37 | ifdef::stalenotes[] |
38 | [NOTE] | |
39 | ============ | |
26cfcfbf | 40 | |
2ff3f61a | 41 | You are reading the documentation for the latest (possibly |
06ab60c0 | 42 | unreleased) version of Git, that is available from the 'master' |
2ff3f61a JH |
43 | branch of the `git.git` repository. |
44 | Documentation for older releases are available here: | |
43a8e4fe | 45 | |
27ea6f85 | 46 | * link:v2.5.2/git.html[documentation for release 2.5.2] |
a17c56c0 JH |
47 | |
48 | * release notes for | |
27ea6f85 | 49 | link:RelNotes/2.5.2.txt[2.5.2], |
c415fb79 | 50 | link:RelNotes/2.5.1.txt[2.5.1], |
e88b8586 | 51 | link:RelNotes/2.5.0.txt[2.5]. |
a17c56c0 | 52 | |
74b67638 | 53 | * link:v2.4.9/git.html[documentation for release 2.4.9] |
3d4a3ffe JH |
54 | |
55 | * release notes for | |
74b67638 | 56 | link:RelNotes/2.4.9.txt[2.4.9], |
8545932d | 57 | link:RelNotes/2.4.8.txt[2.4.8], |
ca00f80b | 58 | link:RelNotes/2.4.7.txt[2.4.7], |
bb3e7b1a | 59 | link:RelNotes/2.4.6.txt[2.4.6], |
0df0541b | 60 | link:RelNotes/2.4.5.txt[2.4.5], |
f09bd215 | 61 | link:RelNotes/2.4.4.txt[2.4.4], |
69f9a6e5 | 62 | link:RelNotes/2.4.3.txt[2.4.3], |
9eabf5b5 | 63 | link:RelNotes/2.4.2.txt[2.4.2], |
aaa7e0d7 | 64 | link:RelNotes/2.4.1.txt[2.4.1], |
3d4a3ffe JH |
65 | link:RelNotes/2.4.0.txt[2.4]. |
66 | ||
ecad27cf | 67 | * link:v2.3.9/git.html[documentation for release 2.3.9] |
9874fca7 JH |
68 | |
69 | * release notes for | |
ecad27cf | 70 | link:RelNotes/2.3.9.txt[2.3.9], |
9a3d6375 | 71 | link:RelNotes/2.3.8.txt[2.3.8], |
16018ae5 | 72 | link:RelNotes/2.3.7.txt[2.3.7], |
ba63bfaa | 73 | link:RelNotes/2.3.6.txt[2.3.6], |
52735a68 | 74 | link:RelNotes/2.3.5.txt[2.3.5], |
3a52578e | 75 | link:RelNotes/2.3.4.txt[2.3.4], |
bb857753 | 76 | link:RelNotes/2.3.3.txt[2.3.3], |
1165ae6f | 77 | link:RelNotes/2.3.2.txt[2.3.2], |
8004647a | 78 | link:RelNotes/2.3.1.txt[2.3.1], |
9874fca7 JH |
79 | link:RelNotes/2.3.0.txt[2.3]. |
80 | ||
441c4a40 | 81 | * link:v2.2.3/git.html[documentation for release 2.2.3] |
b260d265 JH |
82 | |
83 | * release notes for | |
441c4a40 | 84 | link:RelNotes/2.2.3.txt[2.2.3], |
fdf96a20 | 85 | link:RelNotes/2.2.2.txt[2.2.2], |
9b7cbb31 | 86 | link:RelNotes/2.2.1.txt[2.2.1], |
b260d265 JH |
87 | link:RelNotes/2.2.0.txt[2.2]. |
88 | ||
8e36a6d5 | 89 | * link:v2.1.4/git.html[documentation for release 2.1.4] |
6c4ab27f JH |
90 | |
91 | * release notes for | |
8e36a6d5 | 92 | link:RelNotes/2.1.4.txt[2.1.4], |
49c3e926 | 93 | link:RelNotes/2.1.3.txt[2.1.3], |
80b616d0 | 94 | link:RelNotes/2.1.2.txt[2.1.2], |
349cb509 | 95 | link:RelNotes/2.1.1.txt[2.1.1], |
6c4ab27f JH |
96 | link:RelNotes/2.1.0.txt[2.1]. |
97 | ||
9a8c2b67 | 98 | * link:v2.0.5/git.html[documentation for release 2.0.5] |
e156455e JH |
99 | |
100 | * release notes for | |
9a8c2b67 | 101 | link:RelNotes/2.0.5.txt[2.0.5], |
32f56600 | 102 | link:RelNotes/2.0.4.txt[2.0.4], |
740c281d | 103 | link:RelNotes/2.0.3.txt[2.0.3], |
ebc5da32 | 104 | link:RelNotes/2.0.2.txt[2.0.2], |
341e7e8e | 105 | link:RelNotes/2.0.1.txt[2.0.1], |
e156455e JH |
106 | link:RelNotes/2.0.0.txt[2.0.0]. |
107 | ||
83332636 | 108 | * link:v1.9.5/git.html[documentation for release 1.9.5] |
5f95c9f8 JH |
109 | |
110 | * release notes for | |
83332636 | 111 | link:RelNotes/1.9.5.txt[1.9.5], |
34d52175 | 112 | link:RelNotes/1.9.4.txt[1.9.4], |
eea59137 | 113 | link:RelNotes/1.9.3.txt[1.9.3], |
0bc85abb | 114 | link:RelNotes/1.9.2.txt[1.9.2], |
cee0c275 | 115 | link:RelNotes/1.9.1.txt[1.9.1], |
5f95c9f8 JH |
116 | link:RelNotes/1.9.0.txt[1.9.0]. |
117 | ||
5c8213a7 | 118 | * link:v1.8.5.6/git.html[documentation for release 1.8.5.6] |
d2446dfd JH |
119 | |
120 | * release notes for | |
5c8213a7 | 121 | link:RelNotes/1.8.5.6.txt[1.8.5.6], |
7bbc4e8f | 122 | link:RelNotes/1.8.5.5.txt[1.8.5.5], |
3330a2c4 | 123 | link:RelNotes/1.8.5.4.txt[1.8.5.4], |
4224916a | 124 | link:RelNotes/1.8.5.3.txt[1.8.5.3], |
5512ac58 | 125 | link:RelNotes/1.8.5.2.txt[1.8.5.2], |
a155a5f0 | 126 | link:RelNotes/1.8.5.1.txt[1.8.5.1], |
d2446dfd JH |
127 | link:RelNotes/1.8.5.txt[1.8.5]. |
128 | ||
2f93541d | 129 | * link:v1.8.4.5/git.html[documentation for release 1.8.4.5] |
e230c568 JH |
130 | |
131 | * release notes for | |
2f93541d | 132 | link:RelNotes/1.8.4.5.txt[1.8.4.5], |
becb4336 | 133 | link:RelNotes/1.8.4.4.txt[1.8.4.4], |
d7d2c879 | 134 | link:RelNotes/1.8.4.3.txt[1.8.4.3], |
dcb11cca | 135 | link:RelNotes/1.8.4.2.txt[1.8.4.2], |
02a110ad | 136 | link:RelNotes/1.8.4.1.txt[1.8.4.1], |
e230c568 JH |
137 | link:RelNotes/1.8.4.txt[1.8.4]. |
138 | ||
117eea7e | 139 | * link:v1.8.3.4/git.html[documentation for release 1.8.3.4] |
54219a4d JH |
140 | |
141 | * release notes for | |
117eea7e | 142 | link:RelNotes/1.8.3.4.txt[1.8.3.4], |
5addd1c7 | 143 | link:RelNotes/1.8.3.3.txt[1.8.3.3], |
3a461832 | 144 | link:RelNotes/1.8.3.2.txt[1.8.3.2], |
362de916 | 145 | link:RelNotes/1.8.3.1.txt[1.8.3.1], |
54219a4d JH |
146 | link:RelNotes/1.8.3.txt[1.8.3]. |
147 | ||
92758dd2 | 148 | * link:v1.8.2.3/git.html[documentation for release 1.8.2.3] |
239222f5 JH |
149 | |
150 | * release notes for | |
54219a4d JH |
151 | link:RelNotes/1.8.2.3.txt[1.8.2.3], |
152 | link:RelNotes/1.8.2.2.txt[1.8.2.2], | |
153 | link:RelNotes/1.8.2.1.txt[1.8.2.1], | |
239222f5 JH |
154 | link:RelNotes/1.8.2.txt[1.8.2]. |
155 | ||
2137ce01 | 156 | * link:v1.8.1.6/git.html[documentation for release 1.8.1.6] |
5d417842 JH |
157 | |
158 | * release notes for | |
2137ce01 | 159 | link:RelNotes/1.8.1.6.txt[1.8.1.6], |
e6363a49 | 160 | link:RelNotes/1.8.1.5.txt[1.8.1.5], |
dff9f883 | 161 | link:RelNotes/1.8.1.4.txt[1.8.1.4], |
f3500825 JH |
162 | link:RelNotes/1.8.1.3.txt[1.8.1.3], |
163 | link:RelNotes/1.8.1.2.txt[1.8.1.2], | |
e4f59a32 | 164 | link:RelNotes/1.8.1.1.txt[1.8.1.1], |
5d417842 JH |
165 | link:RelNotes/1.8.1.txt[1.8.1]. |
166 | ||
15999998 | 167 | * link:v1.8.0.3/git.html[documentation for release 1.8.0.3] |
8c7a786b JH |
168 | |
169 | * release notes for | |
15999998 | 170 | link:RelNotes/1.8.0.3.txt[1.8.0.3], |
3e53891f | 171 | link:RelNotes/1.8.0.2.txt[1.8.0.2], |
ed9fe755 JH |
172 | link:RelNotes/1.8.0.1.txt[1.8.0.1], |
173 | link:RelNotes/1.8.0.txt[1.8.0]. | |
8c7a786b | 174 | |
7e201053 | 175 | * link:v1.7.12.4/git.html[documentation for release 1.7.12.4] |
889d3589 JH |
176 | |
177 | * release notes for | |
7e201053 | 178 | link:RelNotes/1.7.12.4.txt[1.7.12.4], |
234cd456 | 179 | link:RelNotes/1.7.12.3.txt[1.7.12.3], |
d8cf053d | 180 | link:RelNotes/1.7.12.2.txt[1.7.12.2], |
304b7d99 | 181 | link:RelNotes/1.7.12.1.txt[1.7.12.1], |
889d3589 JH |
182 | link:RelNotes/1.7.12.txt[1.7.12]. |
183 | ||
bafc478f | 184 | * link:v1.7.11.7/git.html[documentation for release 1.7.11.7] |
0ce2e396 JH |
185 | |
186 | * release notes for | |
bafc478f | 187 | link:RelNotes/1.7.11.7.txt[1.7.11.7], |
e09e4024 | 188 | link:RelNotes/1.7.11.6.txt[1.7.11.6], |
cd7c0be1 | 189 | link:RelNotes/1.7.11.5.txt[1.7.11.5], |
0e4c8822 | 190 | link:RelNotes/1.7.11.4.txt[1.7.11.4], |
e6dfbcf1 | 191 | link:RelNotes/1.7.11.3.txt[1.7.11.3], |
8d141a1d | 192 | link:RelNotes/1.7.11.2.txt[1.7.11.2], |
0e64a95a | 193 | link:RelNotes/1.7.11.1.txt[1.7.11.1], |
0ce2e396 JH |
194 | link:RelNotes/1.7.11.txt[1.7.11]. |
195 | ||
785ee496 | 196 | * link:v1.7.10.5/git.html[documentation for release 1.7.10.5] |
e8dde3e5 JH |
197 | |
198 | * release notes for | |
785ee496 | 199 | link:RelNotes/1.7.10.5.txt[1.7.10.5], |
121f71f0 | 200 | link:RelNotes/1.7.10.4.txt[1.7.10.4], |
6a6d72b1 | 201 | link:RelNotes/1.7.10.3.txt[1.7.10.3], |
b6555d73 | 202 | link:RelNotes/1.7.10.2.txt[1.7.10.2], |
bf505158 | 203 | link:RelNotes/1.7.10.1.txt[1.7.10.1], |
e8dde3e5 JH |
204 | link:RelNotes/1.7.10.txt[1.7.10]. |
205 | ||
d0f1ea60 | 206 | * link:v1.7.9.7/git.html[documentation for release 1.7.9.7] |
828ea97d JH |
207 | |
208 | * release notes for | |
d0f1ea60 | 209 | link:RelNotes/1.7.9.7.txt[1.7.9.7], |
cb2ed324 | 210 | link:RelNotes/1.7.9.6.txt[1.7.9.6], |
8ced9c90 | 211 | link:RelNotes/1.7.9.5.txt[1.7.9.5], |
a4603481 | 212 | link:RelNotes/1.7.9.4.txt[1.7.9.4], |
69f4e08f | 213 | link:RelNotes/1.7.9.3.txt[1.7.9.3], |
78f4c9f6 | 214 | link:RelNotes/1.7.9.2.txt[1.7.9.2], |
90020e3b | 215 | link:RelNotes/1.7.9.1.txt[1.7.9.1], |
828ea97d JH |
216 | link:RelNotes/1.7.9.txt[1.7.9]. |
217 | ||
d9f5ef7a | 218 | * link:v1.7.8.6/git.html[documentation for release 1.7.8.6] |
406da780 JH |
219 | |
220 | * release notes for | |
d9f5ef7a | 221 | link:RelNotes/1.7.8.6.txt[1.7.8.6], |
cb2ed324 | 222 | link:RelNotes/1.7.8.5.txt[1.7.8.5], |
c572f491 | 223 | link:RelNotes/1.7.8.4.txt[1.7.8.4], |
5f4d133f JH |
224 | link:RelNotes/1.7.8.3.txt[1.7.8.3], |
225 | link:RelNotes/1.7.8.2.txt[1.7.8.2], | |
226 | link:RelNotes/1.7.8.1.txt[1.7.8.1], | |
406da780 JH |
227 | link:RelNotes/1.7.8.txt[1.7.8]. |
228 | ||
82588584 | 229 | * link:v1.7.7.7/git.html[documentation for release 1.7.7.7] |
703f05ad JH |
230 | |
231 | * release notes for | |
82588584 | 232 | link:RelNotes/1.7.7.7.txt[1.7.7.7], |
c572f491 | 233 | link:RelNotes/1.7.7.6.txt[1.7.7.6], |
66c11f02 JH |
234 | link:RelNotes/1.7.7.5.txt[1.7.7.5], |
235 | link:RelNotes/1.7.7.4.txt[1.7.7.4], | |
236 | link:RelNotes/1.7.7.3.txt[1.7.7.3], | |
237 | link:RelNotes/1.7.7.2.txt[1.7.7.2], | |
f7d958df | 238 | link:RelNotes/1.7.7.1.txt[1.7.7.1], |
703f05ad JH |
239 | link:RelNotes/1.7.7.txt[1.7.7]. |
240 | ||
f174a258 | 241 | * link:v1.7.6.6/git.html[documentation for release 1.7.6.6] |
f696543d JH |
242 | |
243 | * release notes for | |
f174a258 | 244 | link:RelNotes/1.7.6.6.txt[1.7.6.6], |
15b7898c | 245 | link:RelNotes/1.7.6.5.txt[1.7.6.5], |
63205264 | 246 | link:RelNotes/1.7.6.4.txt[1.7.6.4], |
740a8fc2 | 247 | link:RelNotes/1.7.6.3.txt[1.7.6.3], |
509d5970 JH |
248 | link:RelNotes/1.7.6.2.txt[1.7.6.2], |
249 | link:RelNotes/1.7.6.1.txt[1.7.6.1], | |
f696543d JH |
250 | link:RelNotes/1.7.6.txt[1.7.6]. |
251 | ||
e5af0de2 | 252 | * link:v1.7.5.4/git.html[documentation for release 1.7.5.4] |
ec014eac JH |
253 | |
254 | * release notes for | |
e5af0de2 | 255 | link:RelNotes/1.7.5.4.txt[1.7.5.4], |
3c3e0b3c | 256 | link:RelNotes/1.7.5.3.txt[1.7.5.3], |
3d5ae435 | 257 | link:RelNotes/1.7.5.2.txt[1.7.5.2], |
2f312e88 | 258 | link:RelNotes/1.7.5.1.txt[1.7.5.1], |
ec014eac JH |
259 | link:RelNotes/1.7.5.txt[1.7.5]. |
260 | ||
6ceb270c | 261 | * link:v1.7.4.5/git.html[documentation for release 1.7.4.5] |
7ed863a8 JH |
262 | |
263 | * release notes for | |
6ceb270c | 264 | link:RelNotes/1.7.4.5.txt[1.7.4.5], |
6be05591 | 265 | link:RelNotes/1.7.4.4.txt[1.7.4.4], |
cb35c064 JH |
266 | link:RelNotes/1.7.4.3.txt[1.7.4.3], |
267 | link:RelNotes/1.7.4.2.txt[1.7.4.2], | |
9971d6d5 | 268 | link:RelNotes/1.7.4.1.txt[1.7.4.1], |
7ed863a8 JH |
269 | link:RelNotes/1.7.4.txt[1.7.4]. |
270 | ||
685e9d91 | 271 | * link:v1.7.3.5/git.html[documentation for release 1.7.3.5] |
87b50542 JH |
272 | |
273 | * release notes for | |
685e9d91 | 274 | link:RelNotes/1.7.3.5.txt[1.7.3.5], |
15368e18 | 275 | link:RelNotes/1.7.3.4.txt[1.7.3.4], |
ed94cc76 | 276 | link:RelNotes/1.7.3.3.txt[1.7.3.3], |
8a904385 | 277 | link:RelNotes/1.7.3.2.txt[1.7.3.2], |
92c1e717 | 278 | link:RelNotes/1.7.3.1.txt[1.7.3.1], |
87b50542 JH |
279 | link:RelNotes/1.7.3.txt[1.7.3]. |
280 | ||
1b974346 | 281 | * link:v1.7.2.5/git.html[documentation for release 1.7.2.5] |
64fdc08d JH |
282 | |
283 | * release notes for | |
1b974346 | 284 | link:RelNotes/1.7.2.5.txt[1.7.2.5], |
ed94cc76 | 285 | link:RelNotes/1.7.2.4.txt[1.7.2.4], |
761e742d NP |
286 | link:RelNotes/1.7.2.3.txt[1.7.2.3], |
287 | link:RelNotes/1.7.2.2.txt[1.7.2.2], | |
288 | link:RelNotes/1.7.2.1.txt[1.7.2.1], | |
289 | link:RelNotes/1.7.2.txt[1.7.2]. | |
64fdc08d | 290 | |
1b974346 | 291 | * link:v1.7.1.4/git.html[documentation for release 1.7.1.4] |
d599e048 JH |
292 | |
293 | * release notes for | |
1b974346 | 294 | link:RelNotes/1.7.1.4.txt[1.7.1.4], |
ed94cc76 | 295 | link:RelNotes/1.7.1.3.txt[1.7.1.3], |
761e742d NP |
296 | link:RelNotes/1.7.1.2.txt[1.7.1.2], |
297 | link:RelNotes/1.7.1.1.txt[1.7.1.1], | |
298 | link:RelNotes/1.7.1.txt[1.7.1]. | |
d599e048 | 299 | |
1b974346 | 300 | * link:v1.7.0.9/git.html[documentation for release 1.7.0.9] |
e923eaeb JH |
301 | |
302 | * release notes for | |
1b974346 | 303 | link:RelNotes/1.7.0.9.txt[1.7.0.9], |
ed94cc76 | 304 | link:RelNotes/1.7.0.8.txt[1.7.0.8], |
761e742d NP |
305 | link:RelNotes/1.7.0.7.txt[1.7.0.7], |
306 | link:RelNotes/1.7.0.6.txt[1.7.0.6], | |
307 | link:RelNotes/1.7.0.5.txt[1.7.0.5], | |
308 | link:RelNotes/1.7.0.4.txt[1.7.0.4], | |
309 | link:RelNotes/1.7.0.3.txt[1.7.0.3], | |
310 | link:RelNotes/1.7.0.2.txt[1.7.0.2], | |
311 | link:RelNotes/1.7.0.1.txt[1.7.0.1], | |
312 | link:RelNotes/1.7.0.txt[1.7.0]. | |
e923eaeb | 313 | |
1b974346 | 314 | * link:v1.6.6.3/git.html[documentation for release 1.6.6.3] |
902f2353 JH |
315 | |
316 | * release notes for | |
1b974346 | 317 | link:RelNotes/1.6.6.3.txt[1.6.6.3], |
761e742d NP |
318 | link:RelNotes/1.6.6.2.txt[1.6.6.2], |
319 | link:RelNotes/1.6.6.1.txt[1.6.6.1], | |
320 | link:RelNotes/1.6.6.txt[1.6.6]. | |
902f2353 | 321 | |
1b974346 | 322 | * link:v1.6.5.9/git.html[documentation for release 1.6.5.9] |
78d553b7 JH |
323 | |
324 | * release notes for | |
1b974346 | 325 | link:RelNotes/1.6.5.9.txt[1.6.5.9], |
761e742d NP |
326 | link:RelNotes/1.6.5.8.txt[1.6.5.8], |
327 | link:RelNotes/1.6.5.7.txt[1.6.5.7], | |
328 | link:RelNotes/1.6.5.6.txt[1.6.5.6], | |
329 | link:RelNotes/1.6.5.5.txt[1.6.5.5], | |
330 | link:RelNotes/1.6.5.4.txt[1.6.5.4], | |
331 | link:RelNotes/1.6.5.3.txt[1.6.5.3], | |
332 | link:RelNotes/1.6.5.2.txt[1.6.5.2], | |
333 | link:RelNotes/1.6.5.1.txt[1.6.5.1], | |
334 | link:RelNotes/1.6.5.txt[1.6.5]. | |
78d553b7 | 335 | |
1b974346 | 336 | * link:v1.6.4.5/git.html[documentation for release 1.6.4.5] |
0a53e9dd JH |
337 | |
338 | * release notes for | |
1b974346 | 339 | link:RelNotes/1.6.4.5.txt[1.6.4.5], |
761e742d NP |
340 | link:RelNotes/1.6.4.4.txt[1.6.4.4], |
341 | link:RelNotes/1.6.4.3.txt[1.6.4.3], | |
342 | link:RelNotes/1.6.4.2.txt[1.6.4.2], | |
343 | link:RelNotes/1.6.4.1.txt[1.6.4.1], | |
344 | link:RelNotes/1.6.4.txt[1.6.4]. | |
0a53e9dd | 345 | |
441b40d8 | 346 | * link:v1.6.3.4/git.html[documentation for release 1.6.3.4] |
6096d759 JH |
347 | |
348 | * release notes for | |
761e742d NP |
349 | link:RelNotes/1.6.3.4.txt[1.6.3.4], |
350 | link:RelNotes/1.6.3.3.txt[1.6.3.3], | |
351 | link:RelNotes/1.6.3.2.txt[1.6.3.2], | |
352 | link:RelNotes/1.6.3.1.txt[1.6.3.1], | |
353 | link:RelNotes/1.6.3.txt[1.6.3]. | |
a95148de JH |
354 | |
355 | * release notes for | |
761e742d NP |
356 | link:RelNotes/1.6.2.5.txt[1.6.2.5], |
357 | link:RelNotes/1.6.2.4.txt[1.6.2.4], | |
358 | link:RelNotes/1.6.2.3.txt[1.6.2.3], | |
359 | link:RelNotes/1.6.2.2.txt[1.6.2.2], | |
360 | link:RelNotes/1.6.2.1.txt[1.6.2.1], | |
361 | link:RelNotes/1.6.2.txt[1.6.2]. | |
a95148de | 362 | |
621f1b4b | 363 | * link:v1.6.1.3/git.html[documentation for release 1.6.1.3] |
8104ebfe JH |
364 | |
365 | * release notes for | |
761e742d NP |
366 | link:RelNotes/1.6.1.3.txt[1.6.1.3], |
367 | link:RelNotes/1.6.1.2.txt[1.6.1.2], | |
368 | link:RelNotes/1.6.1.1.txt[1.6.1.1], | |
369 | link:RelNotes/1.6.1.txt[1.6.1]. | |
8104ebfe | 370 | |
efe05b01 | 371 | * link:v1.6.0.6/git.html[documentation for release 1.6.0.6] |
ea02eef0 JH |
372 | |
373 | * release notes for | |
761e742d NP |
374 | link:RelNotes/1.6.0.6.txt[1.6.0.6], |
375 | link:RelNotes/1.6.0.5.txt[1.6.0.5], | |
376 | link:RelNotes/1.6.0.4.txt[1.6.0.4], | |
377 | link:RelNotes/1.6.0.3.txt[1.6.0.3], | |
378 | link:RelNotes/1.6.0.2.txt[1.6.0.2], | |
379 | link:RelNotes/1.6.0.1.txt[1.6.0.1], | |
380 | link:RelNotes/1.6.0.txt[1.6.0]. | |
ea02eef0 | 381 | |
efe05b01 | 382 | * link:v1.5.6.6/git.html[documentation for release 1.5.6.6] |
e449f105 JH |
383 | |
384 | * release notes for | |
761e742d NP |
385 | link:RelNotes/1.5.6.6.txt[1.5.6.6], |
386 | link:RelNotes/1.5.6.5.txt[1.5.6.5], | |
387 | link:RelNotes/1.5.6.4.txt[1.5.6.4], | |
388 | link:RelNotes/1.5.6.3.txt[1.5.6.3], | |
389 | link:RelNotes/1.5.6.2.txt[1.5.6.2], | |
390 | link:RelNotes/1.5.6.1.txt[1.5.6.1], | |
391 | link:RelNotes/1.5.6.txt[1.5.6]. | |
e449f105 | 392 | |
efe05b01 | 393 | * link:v1.5.5.6/git.html[documentation for release 1.5.5.6] |
1d2375dd JH |
394 | |
395 | * release notes for | |
761e742d NP |
396 | link:RelNotes/1.5.5.6.txt[1.5.5.6], |
397 | link:RelNotes/1.5.5.5.txt[1.5.5.5], | |
398 | link:RelNotes/1.5.5.4.txt[1.5.5.4], | |
399 | link:RelNotes/1.5.5.3.txt[1.5.5.3], | |
400 | link:RelNotes/1.5.5.2.txt[1.5.5.2], | |
401 | link:RelNotes/1.5.5.1.txt[1.5.5.1], | |
402 | link:RelNotes/1.5.5.txt[1.5.5]. | |
1d2375dd | 403 | |
efe05b01 | 404 | * link:v1.5.4.7/git.html[documentation for release 1.5.4.7] |
6ce8e44a JH |
405 | |
406 | * release notes for | |
761e742d NP |
407 | link:RelNotes/1.5.4.7.txt[1.5.4.7], |
408 | link:RelNotes/1.5.4.6.txt[1.5.4.6], | |
409 | link:RelNotes/1.5.4.5.txt[1.5.4.5], | |
410 | link:RelNotes/1.5.4.4.txt[1.5.4.4], | |
411 | link:RelNotes/1.5.4.3.txt[1.5.4.3], | |
412 | link:RelNotes/1.5.4.2.txt[1.5.4.2], | |
413 | link:RelNotes/1.5.4.1.txt[1.5.4.1], | |
414 | link:RelNotes/1.5.4.txt[1.5.4]. | |
6ce8e44a | 415 | |
e708af6e | 416 | * link:v1.5.3.8/git.html[documentation for release 1.5.3.8] |
5587cac2 JH |
417 | |
418 | * release notes for | |
761e742d NP |
419 | link:RelNotes/1.5.3.8.txt[1.5.3.8], |
420 | link:RelNotes/1.5.3.7.txt[1.5.3.7], | |
421 | link:RelNotes/1.5.3.6.txt[1.5.3.6], | |
422 | link:RelNotes/1.5.3.5.txt[1.5.3.5], | |
423 | link:RelNotes/1.5.3.4.txt[1.5.3.4], | |
424 | link:RelNotes/1.5.3.3.txt[1.5.3.3], | |
425 | link:RelNotes/1.5.3.2.txt[1.5.3.2], | |
426 | link:RelNotes/1.5.3.1.txt[1.5.3.1], | |
427 | link:RelNotes/1.5.3.txt[1.5.3]. | |
b6e4db6a | 428 | |
e636106c JH |
429 | * link:v1.5.2.5/git.html[documentation for release 1.5.2.5] |
430 | ||
aba170cd | 431 | * release notes for |
761e742d NP |
432 | link:RelNotes/1.5.2.5.txt[1.5.2.5], |
433 | link:RelNotes/1.5.2.4.txt[1.5.2.4], | |
434 | link:RelNotes/1.5.2.3.txt[1.5.2.3], | |
435 | link:RelNotes/1.5.2.2.txt[1.5.2.2], | |
436 | link:RelNotes/1.5.2.1.txt[1.5.2.1], | |
437 | link:RelNotes/1.5.2.txt[1.5.2]. | |
aba170cd JH |
438 | |
439 | * link:v1.5.1.6/git.html[documentation for release 1.5.1.6] | |
440 | ||
441 | * release notes for | |
761e742d NP |
442 | link:RelNotes/1.5.1.6.txt[1.5.1.6], |
443 | link:RelNotes/1.5.1.5.txt[1.5.1.5], | |
444 | link:RelNotes/1.5.1.4.txt[1.5.1.4], | |
445 | link:RelNotes/1.5.1.3.txt[1.5.1.3], | |
446 | link:RelNotes/1.5.1.2.txt[1.5.1.2], | |
447 | link:RelNotes/1.5.1.1.txt[1.5.1.1], | |
448 | link:RelNotes/1.5.1.txt[1.5.1]. | |
2ff3f61a JH |
449 | |
450 | * link:v1.5.0.7/git.html[documentation for release 1.5.0.7] | |
451 | ||
aba170cd | 452 | * release notes for |
761e742d NP |
453 | link:RelNotes/1.5.0.7.txt[1.5.0.7], |
454 | link:RelNotes/1.5.0.6.txt[1.5.0.6], | |
455 | link:RelNotes/1.5.0.5.txt[1.5.0.5], | |
456 | link:RelNotes/1.5.0.3.txt[1.5.0.3], | |
457 | link:RelNotes/1.5.0.2.txt[1.5.0.2], | |
458 | link:RelNotes/1.5.0.1.txt[1.5.0.1], | |
459 | link:RelNotes/1.5.0.txt[1.5.0]. | |
2ff3f61a JH |
460 | |
461 | * documentation for release link:v1.4.4.4/git.html[1.4.4.4], | |
462 | link:v1.3.3/git.html[1.3.3], | |
463 | link:v1.2.6/git.html[1.2.6], | |
464 | link:v1.0.13/git.html[1.0.13]. | |
26cfcfbf JH |
465 | |
466 | ============ | |
467 | ||
468 | endif::stalenotes[] | |
469 | ||
cb22bc44 AE |
470 | OPTIONS |
471 | ------- | |
472 | --version:: | |
2de9b711 | 473 | Prints the Git suite version that the 'git' program came from. |
cb22bc44 AE |
474 | |
475 | --help:: | |
a87cd02c | 476 | Prints the synopsis and a list of the most commonly used |
0f6f195b | 477 | commands. If the option '--all' or '-a' is given then all |
2de9b711 | 478 | available commands are printed. If a Git command is named this |
0f6f195b | 479 | option will bring up the manual page for that command. |
45533d26 CC |
480 | + |
481 | Other options are available to control how the manual page is | |
5162e697 | 482 | displayed. See linkgit:git-help[1] for more information, |
db5d6666 JN |
483 | because `git --help ...` is converted internally into `git |
484 | help ...`. | |
cb22bc44 | 485 | |
44e1e4d6 NR |
486 | -C <path>:: |
487 | Run as if git was started in '<path>' instead of the current working | |
488 | directory. When multiple `-C` options are given, each subsequent | |
489 | non-absolute `-C <path>` is interpreted relative to the preceding `-C | |
490 | <path>`. | |
491 | + | |
492 | This option affects options that expect path name like `--git-dir` and | |
493 | `--work-tree` in that their interpretations of the path names would be | |
494 | made relative to the working directory caused by the `-C` option. For | |
495 | example the following invocations are equivalent: | |
496 | ||
497 | git --git-dir=a.git --work-tree=b -C c status | |
498 | git --git-dir=c/a.git --work-tree=c/b status | |
499 | ||
8b1fa778 AR |
500 | -c <name>=<value>:: |
501 | Pass a configuration parameter to the command. The value | |
502 | given will override values from configuration files. | |
503 | The <name> is expected in the same format as listed by | |
504 | 'git config' (subkeys separated by dots). | |
a789ca70 JH |
505 | + |
506 | Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets | |
507 | `foo.bar` to the boolean true value (just like `[foo]bar` would in a | |
508 | config file). Including the equals but with an empty value (like `git -c | |
509 | foo.bar= ...`) sets `foo.bar` to the empty string. | |
8b1fa778 | 510 | |
62b4698e | 511 | --exec-path[=<path>]:: |
2de9b711 | 512 | Path to wherever your core Git programs are installed. |
cb22bc44 | 513 | This can also be controlled by setting the GIT_EXEC_PATH |
56992f76 | 514 | environment variable. If no path is given, 'git' will print |
cb22bc44 AE |
515 | the current setting and then exit. |
516 | ||
89a56bfb | 517 | --html-path:: |
2de9b711 | 518 | Print the path, without trailing slash, where Git's HTML |
239b5ed9 | 519 | documentation is installed and exit. |
89a56bfb | 520 | |
f2dd8c37 | 521 | --man-path:: |
239b5ed9 | 522 | Print the manpath (see `man(1)`) for the man pages for |
2de9b711 | 523 | this version of Git and exit. |
f2dd8c37 JS |
524 | |
525 | --info-path:: | |
239b5ed9 | 526 | Print the path where the Info files documenting this |
2de9b711 | 527 | version of Git are installed and exit. |
89a56bfb | 528 | |
3240240f SB |
529 | -p:: |
530 | --paginate:: | |
06300d97 JN |
531 | Pipe all output into 'less' (or if set, $PAGER) if standard |
532 | output is a terminal. This overrides the `pager.<cmd>` | |
533 | configuration options (see the "Configuration Mechanism" section | |
534 | below). | |
6acbcb92 | 535 | |
463a849d | 536 | --no-pager:: |
2de9b711 | 537 | Do not pipe Git output into a pager. |
463a849d | 538 | |
6acbcb92 JS |
539 | --git-dir=<path>:: |
540 | Set the path to the repository. This can also be controlled by | |
302cc11a LY |
541 | setting the GIT_DIR environment variable. It can be an absolute |
542 | path or relative path to current working directory. | |
6acbcb92 | 543 | |
892c41b9 | 544 | --work-tree=<path>:: |
ea472c1e JH |
545 | Set the path to the working tree. It can be an absolute path |
546 | or a path relative to the current working directory. | |
892c41b9 ML |
547 | This can also be controlled by setting the GIT_WORK_TREE |
548 | environment variable and the core.worktree configuration | |
ea472c1e JH |
549 | variable (see core.worktree in linkgit:git-config[1] for a |
550 | more detailed discussion). | |
892c41b9 | 551 | |
d49483f0 | 552 | --namespace=<path>:: |
2de9b711 | 553 | Set the Git namespace. See linkgit:gitnamespaces[7] for more |
d49483f0 JT |
554 | details. Equivalent to setting the `GIT_NAMESPACE` environment |
555 | variable. | |
556 | ||
6acbcb92 | 557 | --bare:: |
9277d602 JH |
558 | Treat the repository as a bare repository. If GIT_DIR |
559 | environment is not set, it is set to the current working | |
560 | directory. | |
561 | ||
b0fa7ab5 | 562 | --no-replace-objects:: |
2de9b711 | 563 | Do not use replacement refs to replace Git objects. See |
b0fa7ab5 CC |
564 | linkgit:git-replace[1] for more information. |
565 | ||
823ab40f | 566 | --literal-pathspecs:: |
a16bf9dd NTND |
567 | Treat pathspecs literally (i.e. no globbing, no pathspec magic). |
568 | This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment | |
823ab40f JK |
569 | variable to `1`. |
570 | ||
6fb02165 | 571 | --glob-pathspecs:: |
bd30c2e4 NTND |
572 | Add "glob" magic to all pathspec. This is equivalent to setting |
573 | the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling | |
574 | globbing on individual pathspecs can be done using pathspec | |
575 | magic ":(literal)" | |
576 | ||
6fb02165 | 577 | --noglob-pathspecs:: |
bd30c2e4 NTND |
578 | Add "literal" magic to all pathspec. This is equivalent to setting |
579 | the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling | |
580 | globbing on individual pathspecs can be done using pathspec | |
581 | magic ":(glob)" | |
9755afbd | 582 | |
6fb02165 | 583 | --icase-pathspecs:: |
93d93537 NTND |
584 | Add "icase" magic to all pathspec. This is equivalent to setting |
585 | the `GIT_ICASE_PATHSPECS` environment variable to `1`. | |
9755afbd | 586 | |
23091e95 BF |
587 | GIT COMMANDS |
588 | ------------ | |
9755afbd | 589 | |
2de9b711 | 590 | We divide Git into high level ("porcelain") commands and low level |
23091e95 | 591 | ("plumbing") commands. |
8b15e2fb | 592 | |
23091e95 BF |
593 | High-level commands (porcelain) |
594 | ------------------------------- | |
595 | ||
596 | We separate the porcelain commands into the main commands and some | |
597 | ancillary user utilities. | |
598 | ||
599 | Main porcelain commands | |
600 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 601 | |
377e8139 | 602 | include::cmds-mainporcelain.txt[] |
e31bb3bb | 603 | |
90933efb | 604 | Ancillary Commands |
23091e95 | 605 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
606 | Manipulators: |
607 | ||
377e8139 | 608 | include::cmds-ancillarymanipulators.txt[] |
204ee6a9 | 609 | |
90933efb | 610 | Interrogators: |
204ee6a9 | 611 | |
377e8139 | 612 | include::cmds-ancillaryinterrogators.txt[] |
7fc9d69f | 613 | |
89bf2077 JH |
614 | |
615 | Interacting with Others | |
616 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
617 | ||
618 | These commands are to interact with foreign SCM and with other | |
619 | people via patch over e-mail. | |
620 | ||
621 | include::cmds-foreignscminterface.txt[] | |
622 | ||
623 | ||
b1f33d62 RR |
624 | Low-level commands (plumbing) |
625 | ----------------------------- | |
626 | ||
2de9b711 | 627 | Although Git includes its |
b1f33d62 RR |
628 | own porcelain layer, its low-level commands are sufficient to support |
629 | development of alternative porcelains. Developers of such porcelains | |
5162e697 DM |
630 | might start by reading about linkgit:git-update-index[1] and |
631 | linkgit:git-read-tree[1]. | |
b1f33d62 | 632 | |
89bf2077 JH |
633 | The interface (input, output, set of options and the semantics) |
634 | to these low-level commands are meant to be a lot more stable | |
635 | than Porcelain level commands, because these commands are | |
636 | primarily for scripted use. The interface to Porcelain commands | |
637 | on the other hand are subject to change in order to improve the | |
638 | end user experience. | |
639 | ||
640 | The following description divides | |
641 | the low-level commands into commands that manipulate objects (in | |
b1f33d62 RR |
642 | the repository, index, and working tree), commands that interrogate and |
643 | compare objects, and commands that move objects and references between | |
644 | repositories. | |
645 | ||
89bf2077 | 646 | |
b1f33d62 RR |
647 | Manipulation commands |
648 | ~~~~~~~~~~~~~~~~~~~~~ | |
b1f33d62 | 649 | |
377e8139 | 650 | include::cmds-plumbingmanipulators.txt[] |
b1f33d62 RR |
651 | |
652 | ||
653 | Interrogation commands | |
654 | ~~~~~~~~~~~~~~~~~~~~~~ | |
655 | ||
377e8139 | 656 | include::cmds-plumbinginterrogators.txt[] |
b1f33d62 RR |
657 | |
658 | In general, the interrogate commands do not touch the files in | |
659 | the working tree. | |
660 | ||
661 | ||
662 | Synching repositories | |
663 | ~~~~~~~~~~~~~~~~~~~~~ | |
664 | ||
377e8139 | 665 | include::cmds-synchingrepositories.txt[] |
b1f33d62 | 666 | |
57f6ec02 | 667 | The following are helper commands used by the above; end users |
89bf2077 JH |
668 | typically do not use them directly. |
669 | ||
670 | include::cmds-synchelpers.txt[] | |
671 | ||
672 | ||
673 | Internal helper commands | |
674 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
675 | ||
676 | These are internal helper commands used by other commands; end | |
677 | users typically do not use them directly. | |
678 | ||
679 | include::cmds-purehelpers.txt[] | |
680 | ||
b1f33d62 | 681 | |
5773c9f2 JH |
682 | Configuration Mechanism |
683 | ----------------------- | |
684 | ||
c0179c0d MM |
685 | Git uses a simple text format to store customizations that are per |
686 | repository and are per user. Such a configuration file may look | |
687 | like this: | |
5773c9f2 JH |
688 | |
689 | ------------ | |
690 | # | |
2fa090b6 | 691 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
692 | # |
693 | ||
694 | ; core variables | |
695 | [core] | |
696 | ; Don't trust file modes | |
697 | filemode = false | |
698 | ||
699 | ; user identity | |
700 | [user] | |
701 | name = "Junio C Hamano" | |
c0179c0d | 702 | email = "gitster@pobox.com" |
5773c9f2 JH |
703 | |
704 | ------------ | |
705 | ||
706 | Various commands read from the configuration file and adjust | |
06300d97 | 707 | their operation accordingly. See linkgit:git-config[1] for a |
c0179c0d | 708 | list and more details about the configuration mechanism. |
5773c9f2 JH |
709 | |
710 | ||
6c84e2e0 | 711 | Identifier Terminology |
2cf565c5 DG |
712 | ---------------------- |
713 | <object>:: | |
2fa090b6 | 714 | Indicates the object name for any type of object. |
2cf565c5 DG |
715 | |
716 | <blob>:: | |
2fa090b6 | 717 | Indicates a blob object name. |
2cf565c5 DG |
718 | |
719 | <tree>:: | |
2fa090b6 | 720 | Indicates a tree object name. |
2cf565c5 DG |
721 | |
722 | <commit>:: | |
2fa090b6 | 723 | Indicates a commit object name. |
2cf565c5 DG |
724 | |
725 | <tree-ish>:: | |
2fa090b6 | 726 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
727 | command that takes a <tree-ish> argument ultimately wants to |
728 | operate on a <tree> object but automatically dereferences | |
729 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 | 730 | |
043d7605 TT |
731 | <commit-ish>:: |
732 | Indicates a commit or tag object name. A | |
733 | command that takes a <commit-ish> argument ultimately wants to | |
734 | operate on a <commit> object but automatically dereferences | |
735 | <tag> objects that point at a <commit>. | |
736 | ||
2cf565c5 DG |
737 | <type>:: |
738 | Indicates that an object type is required. | |
2fa090b6 | 739 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
740 | |
741 | <file>:: | |
2fa090b6 JH |
742 | Indicates a filename - almost always relative to the |
743 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 744 | |
c1bdacf9 DG |
745 | Symbolic Identifiers |
746 | -------------------- | |
2de9b711 | 747 | Any Git command accepting any <object> can also use the following |
6c84e2e0 | 748 | symbolic notation: |
c1bdacf9 DG |
749 | |
750 | HEAD:: | |
0abcfbff | 751 | indicates the head of the current branch. |
2fa090b6 | 752 | |
c1bdacf9 | 753 | <tag>:: |
2fa090b6 | 754 | a valid tag 'name' |
0abcfbff | 755 | (i.e. a `refs/tags/<tag>` reference). |
2fa090b6 | 756 | |
c1bdacf9 | 757 | <head>:: |
2fa090b6 | 758 | a valid head 'name' |
0abcfbff | 759 | (i.e. a `refs/heads/<head>` reference). |
2fa090b6 | 760 | |
d47107d8 | 761 | For a more complete list of ways to spell object names, see |
9d83e382 | 762 | "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]. |
d47107d8 | 763 | |
c1bdacf9 DG |
764 | |
765 | File/Directory Structure | |
766 | ------------------------ | |
c1bdacf9 | 767 | |
6998e4db | 768 | Please see the linkgit:gitrepository-layout[5] document. |
c1bdacf9 | 769 | |
6998e4db | 770 | Read linkgit:githooks[5] for more details about each hook. |
6250ad1e | 771 | |
c1bdacf9 | 772 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 773 | `$GIT_DIR`. |
c1bdacf9 | 774 | |
a1d4aa74 | 775 | |
2cf565c5 DG |
776 | Terminology |
777 | ----------- | |
6998e4db | 778 | Please see linkgit:gitglossary[7]. |
2cf565c5 DG |
779 | |
780 | ||
781 | Environment Variables | |
782 | --------------------- | |
2de9b711 | 783 | Various Git commands use the following environment variables: |
2cf565c5 | 784 | |
2de9b711 | 785 | The Git Repository |
c1bdacf9 | 786 | ~~~~~~~~~~~~~~~~~~ |
2de9b711 | 787 | These environment variables apply to 'all' core Git commands. Nb: it |
c1bdacf9 | 788 | is worth noting that they may be used/overridden by SCMS sitting above |
f25b98e6 | 789 | Git so take care if using a foreign front-end. |
c1bdacf9 DG |
790 | |
791 | 'GIT_INDEX_FILE':: | |
792 | This environment allows the specification of an alternate | |
5f3aa197 LS |
793 | index file. If not specified, the default of `$GIT_DIR/index` |
794 | is used. | |
c1bdacf9 | 795 | |
136347d7 TG |
796 | 'GIT_INDEX_VERSION':: |
797 | This environment variable allows the specification of an index | |
798 | version for new repositories. It won't affect existing index | |
70320541 NTND |
799 | files. By default index file version 2 or 3 is used. See |
800 | linkgit:git-update-index[1] for more information. | |
136347d7 | 801 | |
c1bdacf9 DG |
802 | 'GIT_OBJECT_DIRECTORY':: |
803 | If the object storage directory is specified via this | |
804 | environment variable then the sha1 directories are created | |
805 | underneath - otherwise the default `$GIT_DIR/objects` | |
806 | directory is used. | |
807 | ||
808 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
2de9b711 | 809 | Due to the immutable nature of Git objects, old objects can be |
c1bdacf9 | 810 | archived into shared, read-only directories. This variable |
80ba074f | 811 | specifies a ":" separated (on Windows ";" separated) list |
2de9b711 | 812 | of Git object directories which can be used to search for Git |
80ba074f | 813 | objects. New objects will not be written to these directories. |
c1bdacf9 DG |
814 | |
815 | 'GIT_DIR':: | |
2fa090b6 JH |
816 | If the 'GIT_DIR' environment variable is set then it |
817 | specifies a path to use instead of the default `.git` | |
818 | for the base of the repository. | |
75940a00 | 819 | The '--git-dir' command-line option also sets this value. |
c1bdacf9 | 820 | |
892c41b9 | 821 | 'GIT_WORK_TREE':: |
a758a349 | 822 | Set the path to the root of the working tree. |
06ab60c0 | 823 | This can also be controlled by the '--work-tree' command-line |
892c41b9 ML |
824 | option and the core.worktree configuration variable. |
825 | ||
d49483f0 | 826 | 'GIT_NAMESPACE':: |
2de9b711 | 827 | Set the Git namespace; see linkgit:gitnamespaces[7] for details. |
d49483f0 JT |
828 | The '--namespace' command-line option also sets this value. |
829 | ||
0454dd93 | 830 | 'GIT_CEILING_DIRECTORIES':: |
7ec30aaa | 831 | This should be a colon-separated list of absolute paths. If |
3e07d268 | 832 | set, it is a list of directories that Git should not chdir up |
7ec30aaa MH |
833 | into while looking for a repository directory (useful for |
834 | excluding slow-loading network directories). It will not | |
835 | exclude the current working directory or a GIT_DIR set on the | |
836 | command line or in the environment. Normally, Git has to read | |
837 | the entries in this list and resolve any symlink that | |
838 | might be present in order to compare them with the current | |
839 | directory. However, if even this access is slow, you | |
840 | can add an empty entry to the list to tell Git that the | |
841 | subsequent entries are not symlinks and needn't be resolved; | |
842 | e.g., | |
843 | 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'. | |
0454dd93 | 844 | |
cf87463e | 845 | 'GIT_DISCOVERY_ACROSS_FILESYSTEM':: |
e6405517 | 846 | When run in a directory that does not have ".git" repository |
2de9b711 | 847 | directory, Git tries to find such a directory in the parent |
e6405517 JH |
848 | directories to find the top of the working tree, but by default it |
849 | does not cross filesystem boundaries. This environment variable | |
2de9b711 | 850 | can be set to true to tell Git not to stop at filesystem |
cf87463e JH |
851 | boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect |
852 | an explicit repository directory set via 'GIT_DIR' or on the | |
853 | command line. | |
8030e442 | 854 | |
c7b3a3d2 NTND |
855 | 'GIT_COMMON_DIR':: |
856 | If this variable is set to a path, non-worktree files that are | |
857 | normally in $GIT_DIR will be taken from this path | |
858 | instead. Worktree-specific files such as HEAD or index are | |
529fef20 | 859 | taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and |
1eaca7a5 | 860 | linkgit:git-worktree[1] for |
c7b3a3d2 NTND |
861 | details. This variable has lower precedence than other path |
862 | variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY... | |
863 | ||
2de9b711 | 864 | Git Commits |
c1bdacf9 DG |
865 | ~~~~~~~~~~~ |
866 | 'GIT_AUTHOR_NAME':: | |
867 | 'GIT_AUTHOR_EMAIL':: | |
868 | 'GIT_AUTHOR_DATE':: | |
869 | 'GIT_COMMITTER_NAME':: | |
870 | 'GIT_COMMITTER_EMAIL':: | |
4e58bf97 | 871 | 'GIT_COMMITTER_DATE':: |
28a94f88 | 872 | 'EMAIL':: |
5162e697 | 873 | see linkgit:git-commit-tree[1] |
c1bdacf9 | 874 | |
2de9b711 | 875 | Git Diffs |
c1bdacf9 | 876 | ~~~~~~~~~ |
d81ed1b5 | 877 | 'GIT_DIFF_OPTS':: |
fde97d8a SE |
878 | Only valid setting is "--unified=??" or "-u??" to set the |
879 | number of context lines shown when a unified diff is created. | |
880 | This takes precedence over any "-U" or "--unified" option | |
2de9b711 | 881 | value passed on the Git diff command line. |
fde97d8a | 882 | |
d81ed1b5 | 883 | 'GIT_EXTERNAL_DIFF':: |
fde97d8a SE |
884 | When the environment variable 'GIT_EXTERNAL_DIFF' is set, the |
885 | program named by it is called, instead of the diff invocation | |
886 | described above. For a path that is added, removed, or modified, | |
887 | 'GIT_EXTERNAL_DIFF' is called with 7 parameters: | |
888 | ||
889 | path old-file old-hex old-mode new-file new-hex new-mode | |
890 | + | |
891 | where: | |
892 | ||
893 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the | |
894 | contents of <old|new>, | |
d5fa1f1a | 895 | <old|new>-hex:: are the 40-hexdigit SHA-1 hashes, |
fde97d8a | 896 | <old|new>-mode:: are the octal representation of the file modes. |
fde97d8a SE |
897 | + |
898 | The file parameters can point at the user's working file | |
899 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` | |
900 | when a new file is added), or a temporary file (e.g. `old-file` in the | |
901 | index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the | |
902 | temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. | |
903 | + | |
904 | For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 | |
905 | parameter, <path>. | |
ee7fb0b1 ZK |
906 | + |
907 | For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables, | |
908 | 'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set. | |
909 | ||
910 | 'GIT_DIFF_PATH_COUNTER':: | |
911 | A 1-based counter incremented by one for every path. | |
912 | ||
913 | 'GIT_DIFF_PATH_TOTAL':: | |
914 | The total number of paths. | |
2cf565c5 | 915 | |
575ba9d6 ML |
916 | other |
917 | ~~~~~ | |
dbddb714 JN |
918 | 'GIT_MERGE_VERBOSITY':: |
919 | A number controlling the amount of output shown by | |
920 | the recursive merge strategy. Overrides merge.verbosity. | |
5162e697 | 921 | See linkgit:git-merge[1] |
dbddb714 | 922 | |
c27d205a | 923 | 'GIT_PAGER':: |
a7738c77 | 924 | This environment variable overrides `$PAGER`. If it is set |
2de9b711 | 925 | to an empty string or to the value "cat", Git will not launch |
ab54cd6c JN |
926 | a pager. See also the `core.pager` option in |
927 | linkgit:git-config[1]. | |
c27d205a | 928 | |
36384c97 RSM |
929 | 'GIT_EDITOR':: |
930 | This environment variable overrides `$EDITOR` and `$VISUAL`. | |
2de9b711 | 931 | It is used by several Git commands when, on interactive mode, |
36384c97 RSM |
932 | an editor is to be launched. See also linkgit:git-var[1] |
933 | and the `core.editor` option in linkgit:git-config[1]. | |
934 | ||
d5538b41 | 935 | 'GIT_SSH':: |
39942766 TQ |
936 | 'GIT_SSH_COMMAND':: |
937 | If either of these environment variables is set then 'git fetch' | |
938 | and 'git push' will use the specified command instead of 'ssh' | |
939 | when they need to connect to a remote system. | |
940 | The command will be given exactly two or four arguments: the | |
941 | 'username@host' (or just 'host') from the URL and the shell | |
942 | command to execute on that remote system, optionally preceded by | |
943 | '-p' (literally) and the 'port' from the URL when it specifies | |
944 | something other than the default SSH port. | |
d5538b41 | 945 | + |
39942766 TQ |
946 | `$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted |
947 | by the shell, which allows additional arguments to be included. | |
948 | `$GIT_SSH` on the other hand must be just the path to a program | |
949 | (which can be a wrapper shell script, if additional arguments are | |
950 | needed). | |
d5538b41 SP |
951 | + |
952 | Usually it is easier to configure any desired options through your | |
953 | personal `.ssh/config` file. Please consult your ssh documentation | |
954 | for further details. | |
955 | ||
453842c9 | 956 | 'GIT_ASKPASS':: |
2de9b711 | 957 | If this environment variable is set, then Git commands which need to |
453842c9 | 958 | acquire passwords or passphrases (e.g. for HTTP or IMAP authentication) |
06ab60c0 | 959 | will call this program with a suitable prompt as command-line argument |
da0005b8 | 960 | and read the password from its STDOUT. See also the 'core.askPass' |
453842c9 KF |
961 | option in linkgit:git-config[1]. |
962 | ||
e652c0eb JK |
963 | 'GIT_TERMINAL_PROMPT':: |
964 | If this environment variable is set to `0`, git will not prompt | |
965 | on the terminal (e.g., when asking for HTTP authentication). | |
966 | ||
e8ef401c JN |
967 | 'GIT_CONFIG_NOSYSTEM':: |
968 | Whether to skip reading settings from the system-wide | |
969 | `$(prefix)/etc/gitconfig` file. This environment variable can | |
970 | be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a | |
971 | predictable environment for a picky script, or you can set it | |
972 | temporarily to avoid using a buggy `/etc/gitconfig` file while | |
973 | waiting for someone with sufficient permissions to fix it. | |
974 | ||
06f59e9f TT |
975 | 'GIT_FLUSH':: |
976 | If this environment variable is set to "1", then commands such | |
0b444cdb | 977 | as 'git blame' (in incremental mode), 'git rev-list', 'git log', |
627a8b8d | 978 | 'git check-attr' and 'git check-ignore' will |
f1ed7fea AS |
979 | force a flush of the output stream after each record have been |
980 | flushed. If this | |
06f59e9f TT |
981 | variable is set to "0", the output of these commands will be done |
982 | using completely buffered I/O. If this environment variable is | |
2de9b711 | 983 | not set, Git will choose buffered or record-oriented flushing |
06f59e9f TT |
984 | based on whether stdout appears to be redirected to a file or not. |
985 | ||
575ba9d6 | 986 | 'GIT_TRACE':: |
eb9250df KB |
987 | Enables general trace messages, e.g. alias expansion, built-in |
988 | command execution and external command execution. | |
989 | + | |
990 | If this variable is set to "1", "2" or "true" (comparison | |
991 | is case insensitive), trace messages will be printed to | |
992 | stderr. | |
993 | + | |
994 | If the variable is set to an integer value greater than 2 | |
995 | and lower than 10 (strictly) then Git will interpret this | |
996 | value as an open file descriptor and will try to write the | |
997 | trace messages into this file descriptor. | |
998 | + | |
999 | Alternatively, if the variable is set to an absolute path | |
1000 | (starting with a '/' character), Git will interpret this | |
1001 | as a file path and will try to write the trace messages | |
1002 | into it. | |
1003 | + | |
1004 | Unsetting the variable, or setting it to empty, "0" or | |
1005 | "false" (case insensitive) disables trace messages. | |
575ba9d6 | 1006 | |
b12ca963 | 1007 | 'GIT_TRACE_PACK_ACCESS':: |
67dc598e | 1008 | Enables trace messages for all accesses to any packs. For each |
b12ca963 NTND |
1009 | access, the pack file name and an offset in the pack is |
1010 | recorded. This may be helpful for troubleshooting some | |
1011 | pack-related performance problems. | |
67dc598e | 1012 | See 'GIT_TRACE' for available trace output options. |
b12ca963 | 1013 | |
1dd278ce | 1014 | 'GIT_TRACE_PACKET':: |
eb9250df KB |
1015 | Enables trace messages for all packets coming in or out of a |
1016 | given program. This can help with debugging object negotiation | |
1017 | or other protocol issues. Tracing is turned off at a packet | |
1018 | starting with "PACK". | |
1019 | See 'GIT_TRACE' for available trace output options. | |
1020 | ||
578da039 KB |
1021 | 'GIT_TRACE_PERFORMANCE':: |
1022 | Enables performance related trace messages, e.g. total execution | |
1023 | time of each Git command. | |
1024 | See 'GIT_TRACE' for available trace output options. | |
1025 | ||
eb9250df KB |
1026 | 'GIT_TRACE_SETUP':: |
1027 | Enables trace messages printing the .git, working tree and current | |
1028 | working directory after Git has completed its setup phase. | |
1029 | See 'GIT_TRACE' for available trace output options. | |
1030 | ||
1031 | 'GIT_TRACE_SHALLOW':: | |
1032 | Enables trace messages that can help debugging fetching / | |
1033 | cloning of shallow repositories. | |
1034 | See 'GIT_TRACE' for available trace output options. | |
1dd278ce | 1035 | |
823ab40f | 1036 | GIT_LITERAL_PATHSPECS:: |
2de9b711 | 1037 | Setting this variable to `1` will cause Git to treat all |
823ab40f JK |
1038 | pathspecs literally, rather than as glob patterns. For example, |
1039 | running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search | |
1040 | for commits that touch the path `*.c`, not any paths that the | |
1041 | glob `*.c` matches. You might want this if you are feeding | |
2de9b711 | 1042 | literal paths to Git (e.g., paths previously given to you by |
823ab40f JK |
1043 | `git ls-tree`, `--raw` diff output, etc). |
1044 | ||
bd30c2e4 NTND |
1045 | GIT_GLOB_PATHSPECS:: |
1046 | Setting this variable to `1` will cause Git to treat all | |
1047 | pathspecs as glob patterns (aka "glob" magic). | |
1048 | ||
1049 | GIT_NOGLOB_PATHSPECS:: | |
1050 | Setting this variable to `1` will cause Git to treat all | |
1051 | pathspecs as literal (aka "literal" magic). | |
1052 | ||
93d93537 NTND |
1053 | GIT_ICASE_PATHSPECS:: |
1054 | Setting this variable to `1` will cause Git to treat all | |
1055 | pathspecs as case-insensitive. | |
1056 | ||
c3e2d189 JH |
1057 | 'GIT_REFLOG_ACTION':: |
1058 | When a ref is updated, reflog entries are created to keep | |
1059 | track of the reason why the ref was updated (which is | |
1060 | typically the name of the high-level command that updated | |
1061 | the ref), in addition to the old and new values of the ref. | |
1062 | A scripted Porcelain command can use set_reflog_action | |
1063 | helper function in `git-sh-setup` to set its name to this | |
1064 | variable when it is invoked as the top level command by the | |
1065 | end user, to be recorded in the body of the reflog. | |
1066 | ||
49672f26 JK |
1067 | `GIT_REF_PARANOIA`:: |
1068 | If set to `1`, include broken or badly named refs when iterating | |
1069 | over lists of refs. In a normal, non-corrupted repository, this | |
1070 | does nothing. However, enabling it may help git to detect and | |
1071 | abort some operations in the presence of broken refs. Git sets | |
1072 | this variable automatically when performing destructive | |
1073 | operations like linkgit:git-prune[1]. You should not need to set | |
1074 | it yourself unless you want to be paranoid about making sure | |
1075 | an operation has touched every ref (e.g., because you are | |
1076 | cloning a repository to make a backup). | |
1077 | ||
823ab40f | 1078 | |
8db9307c JH |
1079 | Discussion[[Discussion]] |
1080 | ------------------------ | |
40dac517 BF |
1081 | |
1082 | More detail on the following is available from the | |
2de9b711 | 1083 | link:user-manual.html#git-concepts[Git concepts chapter of the |
6998e4db | 1084 | user-manual] and linkgit:gitcore-tutorial[7]. |
40dac517 | 1085 | |
2de9b711 | 1086 | A Git project normally consists of a working directory with a ".git" |
40dac517 BF |
1087 | subdirectory at the top level. The .git directory contains, among other |
1088 | things, a compressed object database representing the complete history | |
1089 | of the project, an "index" file which links that history to the current | |
1090 | contents of the working tree, and named pointers into that history such | |
1091 | as tags and branch heads. | |
1092 | ||
1093 | The object database contains objects of three main types: blobs, which | |
1094 | hold file data; trees, which point to blobs and other trees to build up | |
02ff6250 | 1095 | directory hierarchies; and commits, which each reference a single tree |
40dac517 BF |
1096 | and some number of parent commits. |
1097 | ||
1098 | The commit, equivalent to what other systems call a "changeset" or | |
1099 | "version", represents a step in the project's history, and each parent | |
1100 | represents an immediately preceding step. Commits with more than one | |
1101 | parent represent merges of independent lines of development. | |
1102 | ||
d5fa1f1a | 1103 | All objects are named by the SHA-1 hash of their contents, normally |
40dac517 BF |
1104 | written as a string of 40 hex digits. Such names are globally unique. |
1105 | The entire history leading up to a commit can be vouched for by signing | |
1106 | just that commit. A fourth object type, the tag, is provided for this | |
1107 | purpose. | |
1108 | ||
1109 | When first created, objects are stored in individual files, but for | |
1110 | efficiency may later be compressed together into "pack files". | |
1111 | ||
1112 | Named pointers called refs mark interesting points in history. A ref | |
d5fa1f1a TA |
1113 | may contain the SHA-1 name of an object or the name of another ref. Refs |
1114 | with names beginning `ref/head/` contain the SHA-1 name of the most | |
1115 | recent commit (or "head") of a branch under development. SHA-1 names of | |
40dac517 BF |
1116 | tags of interest are stored under `ref/tags/`. A special ref named |
1117 | `HEAD` contains the name of the currently checked-out branch. | |
1118 | ||
1119 | The index file is initialized with a list of all paths and, for each | |
1120 | path, a blob object and a set of attributes. The blob object represents | |
1121 | the contents of the file as of the head of the current branch. The | |
1122 | attributes (last modified time, size, etc.) are taken from the | |
1123 | corresponding file in the working tree. Subsequent changes to the | |
1124 | working tree can be found by comparing these attributes. The index may | |
1125 | be updated with new content, and new commits may be created from the | |
1126 | content stored in the index. | |
1127 | ||
1128 | The index is also capable of storing multiple entries (called "stages") | |
1129 | for a given pathname. These stages are used to hold the various | |
1130 | unmerged version of a file when a merge is in progress. | |
6c84e2e0 | 1131 | |
7687ae98 JH |
1132 | FURTHER DOCUMENTATION |
1133 | --------------------- | |
1134 | ||
1135 | See the references in the "description" section to get started | |
2de9b711 | 1136 | using Git. The following is probably more detail than necessary |
7687ae98 JH |
1137 | for a first-time user. |
1138 | ||
2de9b711 | 1139 | The link:user-manual.html#git-concepts[Git concepts chapter of the |
7687ae98 | 1140 | user-manual] and linkgit:gitcore-tutorial[7] both provide |
2de9b711 | 1141 | introductions to the underlying Git architecture. |
7687ae98 JH |
1142 | |
1143 | See linkgit:gitworkflows[7] for an overview of recommended workflows. | |
1144 | ||
1145 | See also the link:howto-index.html[howto] documents for some useful | |
1146 | examples. | |
1147 | ||
1148 | The internals are documented in the | |
48a8c26c | 1149 | link:technical/api-index.html[Git API documentation]. |
7687ae98 JH |
1150 | |
1151 | Users migrating from CVS may also want to | |
1152 | read linkgit:gitcvs-migration[7]. | |
1153 | ||
1154 | ||
cb22bc44 AE |
1155 | Authors |
1156 | ------- | |
48bb914e | 1157 | Git was started by Linus Torvalds, and is currently maintained by Junio |
2de9b711 | 1158 | C Hamano. Numerous contributions have come from the Git mailing list |
405869d0 | 1159 | <git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary |
6ecc01f2 JH |
1160 | gives you a more complete list of contributors. |
1161 | ||
1162 | If you have a clone of git.git itself, the | |
d8f708f8 JK |
1163 | output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you |
1164 | the authors for specific parts of the project. | |
2cf565c5 | 1165 | |
c97ca277 JH |
1166 | Reporting Bugs |
1167 | -------------- | |
1168 | ||
1169 | Report bugs to the Git mailing list <git@vger.kernel.org> where the | |
1170 | development and maintenance is primarily done. You do not have to be | |
1171 | subscribed to the list to send a message there. | |
1172 | ||
497c8331 CC |
1173 | SEE ALSO |
1174 | -------- | |
1175 | linkgit:gittutorial[7], linkgit:gittutorial-2[7], | |
673151a9 | 1176 | linkgit:giteveryday[7], linkgit:gitcvs-migration[7], |
497c8331 | 1177 | linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], |
801a011d TR |
1178 | linkgit:gitcli[7], link:user-manual.html[The Git User's Manual], |
1179 | linkgit:gitworkflows[7] | |
497c8331 | 1180 | |
2cf565c5 DG |
1181 | GIT |
1182 | --- | |
9e1f0a85 | 1183 | Part of the linkgit:git[1] suite |