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