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