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