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