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