]>
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] |
68e4b552 ZJS |
12 | 'git' [--version] [--help] [-c <name>=<value>] |
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 |
23091e95 BF |
25 | link:everyday.html[Everyday Git] for a useful minimum set of commands, and |
26 | "man git-commandname" for documentation of each command. CVS users may | |
6998e4db JN |
27 | also want to read linkgit:gitcvs-migration[7]. See |
28 | the link:user-manual.html[Git User's Manual] for a more in-depth | |
a1dc34fa | 29 | introduction. |
cb22bc44 | 30 | |
62b4698e | 31 | The '<command>' is either a name of a Git command (see below) or an alias |
5162e697 | 32 | as defined in the configuration file (see linkgit:git-config[1]). |
4514ad4f | 33 | |
34b604af JA |
34 | Formatted and hyperlinked version of the latest git |
35 | documentation can be viewed at | |
36 | `http://www.kernel.org/pub/software/scm/git/docs/`. | |
37 | ||
26cfcfbf JH |
38 | ifdef::stalenotes[] |
39 | [NOTE] | |
40 | ============ | |
26cfcfbf | 41 | |
2ff3f61a JH |
42 | You are reading the documentation for the latest (possibly |
43 | unreleased) version of git, that is available from 'master' | |
44 | branch of the `git.git` repository. | |
45 | Documentation for older releases are available here: | |
43a8e4fe | 46 | |
90020e3b | 47 | * link:v1.7.9.1/git.html[documentation for release 1.7.9.1] |
828ea97d JH |
48 | |
49 | * release notes for | |
90020e3b | 50 | link:RelNotes/1.7.9.1.txt[1.7.9.1], |
828ea97d JH |
51 | link:RelNotes/1.7.9.txt[1.7.9]. |
52 | ||
c572f491 | 53 | * link:v1.7.8.4/git.html[documentation for release 1.7.8.4] |
406da780 JH |
54 | |
55 | * release notes for | |
c572f491 | 56 | link:RelNotes/1.7.8.4.txt[1.7.8.4], |
5f4d133f JH |
57 | link:RelNotes/1.7.8.3.txt[1.7.8.3], |
58 | link:RelNotes/1.7.8.2.txt[1.7.8.2], | |
59 | link:RelNotes/1.7.8.1.txt[1.7.8.1], | |
406da780 JH |
60 | link:RelNotes/1.7.8.txt[1.7.8]. |
61 | ||
c572f491 | 62 | * link:v1.7.7.6/git.html[documentation for release 1.7.7.6] |
703f05ad JH |
63 | |
64 | * release notes for | |
c572f491 | 65 | link:RelNotes/1.7.7.6.txt[1.7.7.6], |
66c11f02 JH |
66 | link:RelNotes/1.7.7.5.txt[1.7.7.5], |
67 | link:RelNotes/1.7.7.4.txt[1.7.7.4], | |
68 | link:RelNotes/1.7.7.3.txt[1.7.7.3], | |
69 | link:RelNotes/1.7.7.2.txt[1.7.7.2], | |
f7d958df | 70 | link:RelNotes/1.7.7.1.txt[1.7.7.1], |
703f05ad JH |
71 | link:RelNotes/1.7.7.txt[1.7.7]. |
72 | ||
f174a258 | 73 | * link:v1.7.6.6/git.html[documentation for release 1.7.6.6] |
f696543d JH |
74 | |
75 | * release notes for | |
f174a258 | 76 | link:RelNotes/1.7.6.6.txt[1.7.6.6], |
15b7898c | 77 | link:RelNotes/1.7.6.5.txt[1.7.6.5], |
63205264 | 78 | link:RelNotes/1.7.6.4.txt[1.7.6.4], |
740a8fc2 | 79 | link:RelNotes/1.7.6.3.txt[1.7.6.3], |
509d5970 JH |
80 | link:RelNotes/1.7.6.2.txt[1.7.6.2], |
81 | link:RelNotes/1.7.6.1.txt[1.7.6.1], | |
f696543d JH |
82 | link:RelNotes/1.7.6.txt[1.7.6]. |
83 | ||
e5af0de2 | 84 | * link:v1.7.5.4/git.html[documentation for release 1.7.5.4] |
ec014eac JH |
85 | |
86 | * release notes for | |
e5af0de2 | 87 | link:RelNotes/1.7.5.4.txt[1.7.5.4], |
3c3e0b3c | 88 | link:RelNotes/1.7.5.3.txt[1.7.5.3], |
3d5ae435 | 89 | link:RelNotes/1.7.5.2.txt[1.7.5.2], |
2f312e88 | 90 | link:RelNotes/1.7.5.1.txt[1.7.5.1], |
ec014eac JH |
91 | link:RelNotes/1.7.5.txt[1.7.5]. |
92 | ||
6ceb270c | 93 | * link:v1.7.4.5/git.html[documentation for release 1.7.4.5] |
7ed863a8 JH |
94 | |
95 | * release notes for | |
6ceb270c | 96 | link:RelNotes/1.7.4.5.txt[1.7.4.5], |
6be05591 | 97 | link:RelNotes/1.7.4.4.txt[1.7.4.4], |
cb35c064 JH |
98 | link:RelNotes/1.7.4.3.txt[1.7.4.3], |
99 | link:RelNotes/1.7.4.2.txt[1.7.4.2], | |
9971d6d5 | 100 | link:RelNotes/1.7.4.1.txt[1.7.4.1], |
7ed863a8 JH |
101 | link:RelNotes/1.7.4.txt[1.7.4]. |
102 | ||
685e9d91 | 103 | * link:v1.7.3.5/git.html[documentation for release 1.7.3.5] |
87b50542 JH |
104 | |
105 | * release notes for | |
685e9d91 | 106 | link:RelNotes/1.7.3.5.txt[1.7.3.5], |
15368e18 | 107 | link:RelNotes/1.7.3.4.txt[1.7.3.4], |
ed94cc76 | 108 | link:RelNotes/1.7.3.3.txt[1.7.3.3], |
8a904385 | 109 | link:RelNotes/1.7.3.2.txt[1.7.3.2], |
92c1e717 | 110 | link:RelNotes/1.7.3.1.txt[1.7.3.1], |
87b50542 JH |
111 | link:RelNotes/1.7.3.txt[1.7.3]. |
112 | ||
1b974346 | 113 | * link:v1.7.2.5/git.html[documentation for release 1.7.2.5] |
64fdc08d JH |
114 | |
115 | * release notes for | |
1b974346 | 116 | link:RelNotes/1.7.2.5.txt[1.7.2.5], |
ed94cc76 | 117 | link:RelNotes/1.7.2.4.txt[1.7.2.4], |
761e742d NP |
118 | link:RelNotes/1.7.2.3.txt[1.7.2.3], |
119 | link:RelNotes/1.7.2.2.txt[1.7.2.2], | |
120 | link:RelNotes/1.7.2.1.txt[1.7.2.1], | |
121 | link:RelNotes/1.7.2.txt[1.7.2]. | |
64fdc08d | 122 | |
1b974346 | 123 | * link:v1.7.1.4/git.html[documentation for release 1.7.1.4] |
d599e048 JH |
124 | |
125 | * release notes for | |
1b974346 | 126 | link:RelNotes/1.7.1.4.txt[1.7.1.4], |
ed94cc76 | 127 | link:RelNotes/1.7.1.3.txt[1.7.1.3], |
761e742d NP |
128 | link:RelNotes/1.7.1.2.txt[1.7.1.2], |
129 | link:RelNotes/1.7.1.1.txt[1.7.1.1], | |
130 | link:RelNotes/1.7.1.txt[1.7.1]. | |
d599e048 | 131 | |
1b974346 | 132 | * link:v1.7.0.9/git.html[documentation for release 1.7.0.9] |
e923eaeb JH |
133 | |
134 | * release notes for | |
1b974346 | 135 | link:RelNotes/1.7.0.9.txt[1.7.0.9], |
ed94cc76 | 136 | link:RelNotes/1.7.0.8.txt[1.7.0.8], |
761e742d NP |
137 | link:RelNotes/1.7.0.7.txt[1.7.0.7], |
138 | link:RelNotes/1.7.0.6.txt[1.7.0.6], | |
139 | link:RelNotes/1.7.0.5.txt[1.7.0.5], | |
140 | link:RelNotes/1.7.0.4.txt[1.7.0.4], | |
141 | link:RelNotes/1.7.0.3.txt[1.7.0.3], | |
142 | link:RelNotes/1.7.0.2.txt[1.7.0.2], | |
143 | link:RelNotes/1.7.0.1.txt[1.7.0.1], | |
144 | link:RelNotes/1.7.0.txt[1.7.0]. | |
e923eaeb | 145 | |
1b974346 | 146 | * link:v1.6.6.3/git.html[documentation for release 1.6.6.3] |
902f2353 JH |
147 | |
148 | * release notes for | |
1b974346 | 149 | link:RelNotes/1.6.6.3.txt[1.6.6.3], |
761e742d NP |
150 | link:RelNotes/1.6.6.2.txt[1.6.6.2], |
151 | link:RelNotes/1.6.6.1.txt[1.6.6.1], | |
152 | link:RelNotes/1.6.6.txt[1.6.6]. | |
902f2353 | 153 | |
1b974346 | 154 | * link:v1.6.5.9/git.html[documentation for release 1.6.5.9] |
78d553b7 JH |
155 | |
156 | * release notes for | |
1b974346 | 157 | link:RelNotes/1.6.5.9.txt[1.6.5.9], |
761e742d NP |
158 | link:RelNotes/1.6.5.8.txt[1.6.5.8], |
159 | link:RelNotes/1.6.5.7.txt[1.6.5.7], | |
160 | link:RelNotes/1.6.5.6.txt[1.6.5.6], | |
161 | link:RelNotes/1.6.5.5.txt[1.6.5.5], | |
162 | link:RelNotes/1.6.5.4.txt[1.6.5.4], | |
163 | link:RelNotes/1.6.5.3.txt[1.6.5.3], | |
164 | link:RelNotes/1.6.5.2.txt[1.6.5.2], | |
165 | link:RelNotes/1.6.5.1.txt[1.6.5.1], | |
166 | link:RelNotes/1.6.5.txt[1.6.5]. | |
78d553b7 | 167 | |
1b974346 | 168 | * link:v1.6.4.5/git.html[documentation for release 1.6.4.5] |
0a53e9dd JH |
169 | |
170 | * release notes for | |
1b974346 | 171 | link:RelNotes/1.6.4.5.txt[1.6.4.5], |
761e742d NP |
172 | link:RelNotes/1.6.4.4.txt[1.6.4.4], |
173 | link:RelNotes/1.6.4.3.txt[1.6.4.3], | |
174 | link:RelNotes/1.6.4.2.txt[1.6.4.2], | |
175 | link:RelNotes/1.6.4.1.txt[1.6.4.1], | |
176 | link:RelNotes/1.6.4.txt[1.6.4]. | |
0a53e9dd | 177 | |
441b40d8 | 178 | * link:v1.6.3.4/git.html[documentation for release 1.6.3.4] |
6096d759 JH |
179 | |
180 | * release notes for | |
761e742d NP |
181 | link:RelNotes/1.6.3.4.txt[1.6.3.4], |
182 | link:RelNotes/1.6.3.3.txt[1.6.3.3], | |
183 | link:RelNotes/1.6.3.2.txt[1.6.3.2], | |
184 | link:RelNotes/1.6.3.1.txt[1.6.3.1], | |
185 | link:RelNotes/1.6.3.txt[1.6.3]. | |
a95148de JH |
186 | |
187 | * release notes for | |
761e742d NP |
188 | link:RelNotes/1.6.2.5.txt[1.6.2.5], |
189 | link:RelNotes/1.6.2.4.txt[1.6.2.4], | |
190 | link:RelNotes/1.6.2.3.txt[1.6.2.3], | |
191 | link:RelNotes/1.6.2.2.txt[1.6.2.2], | |
192 | link:RelNotes/1.6.2.1.txt[1.6.2.1], | |
193 | link:RelNotes/1.6.2.txt[1.6.2]. | |
a95148de | 194 | |
621f1b4b | 195 | * link:v1.6.1.3/git.html[documentation for release 1.6.1.3] |
8104ebfe JH |
196 | |
197 | * release notes for | |
761e742d NP |
198 | link:RelNotes/1.6.1.3.txt[1.6.1.3], |
199 | link:RelNotes/1.6.1.2.txt[1.6.1.2], | |
200 | link:RelNotes/1.6.1.1.txt[1.6.1.1], | |
201 | link:RelNotes/1.6.1.txt[1.6.1]. | |
8104ebfe | 202 | |
efe05b01 | 203 | * link:v1.6.0.6/git.html[documentation for release 1.6.0.6] |
ea02eef0 JH |
204 | |
205 | * release notes for | |
761e742d NP |
206 | link:RelNotes/1.6.0.6.txt[1.6.0.6], |
207 | link:RelNotes/1.6.0.5.txt[1.6.0.5], | |
208 | link:RelNotes/1.6.0.4.txt[1.6.0.4], | |
209 | link:RelNotes/1.6.0.3.txt[1.6.0.3], | |
210 | link:RelNotes/1.6.0.2.txt[1.6.0.2], | |
211 | link:RelNotes/1.6.0.1.txt[1.6.0.1], | |
212 | link:RelNotes/1.6.0.txt[1.6.0]. | |
ea02eef0 | 213 | |
efe05b01 | 214 | * link:v1.5.6.6/git.html[documentation for release 1.5.6.6] |
e449f105 JH |
215 | |
216 | * release notes for | |
761e742d NP |
217 | link:RelNotes/1.5.6.6.txt[1.5.6.6], |
218 | link:RelNotes/1.5.6.5.txt[1.5.6.5], | |
219 | link:RelNotes/1.5.6.4.txt[1.5.6.4], | |
220 | link:RelNotes/1.5.6.3.txt[1.5.6.3], | |
221 | link:RelNotes/1.5.6.2.txt[1.5.6.2], | |
222 | link:RelNotes/1.5.6.1.txt[1.5.6.1], | |
223 | link:RelNotes/1.5.6.txt[1.5.6]. | |
e449f105 | 224 | |
efe05b01 | 225 | * link:v1.5.5.6/git.html[documentation for release 1.5.5.6] |
1d2375dd JH |
226 | |
227 | * release notes for | |
761e742d NP |
228 | link:RelNotes/1.5.5.6.txt[1.5.5.6], |
229 | link:RelNotes/1.5.5.5.txt[1.5.5.5], | |
230 | link:RelNotes/1.5.5.4.txt[1.5.5.4], | |
231 | link:RelNotes/1.5.5.3.txt[1.5.5.3], | |
232 | link:RelNotes/1.5.5.2.txt[1.5.5.2], | |
233 | link:RelNotes/1.5.5.1.txt[1.5.5.1], | |
234 | link:RelNotes/1.5.5.txt[1.5.5]. | |
1d2375dd | 235 | |
efe05b01 | 236 | * link:v1.5.4.7/git.html[documentation for release 1.5.4.7] |
6ce8e44a JH |
237 | |
238 | * release notes for | |
761e742d NP |
239 | link:RelNotes/1.5.4.7.txt[1.5.4.7], |
240 | link:RelNotes/1.5.4.6.txt[1.5.4.6], | |
241 | link:RelNotes/1.5.4.5.txt[1.5.4.5], | |
242 | link:RelNotes/1.5.4.4.txt[1.5.4.4], | |
243 | link:RelNotes/1.5.4.3.txt[1.5.4.3], | |
244 | link:RelNotes/1.5.4.2.txt[1.5.4.2], | |
245 | link:RelNotes/1.5.4.1.txt[1.5.4.1], | |
246 | link:RelNotes/1.5.4.txt[1.5.4]. | |
6ce8e44a | 247 | |
e708af6e | 248 | * link:v1.5.3.8/git.html[documentation for release 1.5.3.8] |
5587cac2 JH |
249 | |
250 | * release notes for | |
761e742d NP |
251 | link:RelNotes/1.5.3.8.txt[1.5.3.8], |
252 | link:RelNotes/1.5.3.7.txt[1.5.3.7], | |
253 | link:RelNotes/1.5.3.6.txt[1.5.3.6], | |
254 | link:RelNotes/1.5.3.5.txt[1.5.3.5], | |
255 | link:RelNotes/1.5.3.4.txt[1.5.3.4], | |
256 | link:RelNotes/1.5.3.3.txt[1.5.3.3], | |
257 | link:RelNotes/1.5.3.2.txt[1.5.3.2], | |
258 | link:RelNotes/1.5.3.1.txt[1.5.3.1], | |
259 | link:RelNotes/1.5.3.txt[1.5.3]. | |
b6e4db6a | 260 | |
e636106c JH |
261 | * link:v1.5.2.5/git.html[documentation for release 1.5.2.5] |
262 | ||
aba170cd | 263 | * release notes for |
761e742d NP |
264 | link:RelNotes/1.5.2.5.txt[1.5.2.5], |
265 | link:RelNotes/1.5.2.4.txt[1.5.2.4], | |
266 | link:RelNotes/1.5.2.3.txt[1.5.2.3], | |
267 | link:RelNotes/1.5.2.2.txt[1.5.2.2], | |
268 | link:RelNotes/1.5.2.1.txt[1.5.2.1], | |
269 | link:RelNotes/1.5.2.txt[1.5.2]. | |
aba170cd JH |
270 | |
271 | * link:v1.5.1.6/git.html[documentation for release 1.5.1.6] | |
272 | ||
273 | * release notes for | |
761e742d NP |
274 | link:RelNotes/1.5.1.6.txt[1.5.1.6], |
275 | link:RelNotes/1.5.1.5.txt[1.5.1.5], | |
276 | link:RelNotes/1.5.1.4.txt[1.5.1.4], | |
277 | link:RelNotes/1.5.1.3.txt[1.5.1.3], | |
278 | link:RelNotes/1.5.1.2.txt[1.5.1.2], | |
279 | link:RelNotes/1.5.1.1.txt[1.5.1.1], | |
280 | link:RelNotes/1.5.1.txt[1.5.1]. | |
2ff3f61a JH |
281 | |
282 | * link:v1.5.0.7/git.html[documentation for release 1.5.0.7] | |
283 | ||
aba170cd | 284 | * release notes for |
761e742d NP |
285 | link:RelNotes/1.5.0.7.txt[1.5.0.7], |
286 | link:RelNotes/1.5.0.6.txt[1.5.0.6], | |
287 | link:RelNotes/1.5.0.5.txt[1.5.0.5], | |
288 | link:RelNotes/1.5.0.3.txt[1.5.0.3], | |
289 | link:RelNotes/1.5.0.2.txt[1.5.0.2], | |
290 | link:RelNotes/1.5.0.1.txt[1.5.0.1], | |
291 | link:RelNotes/1.5.0.txt[1.5.0]. | |
2ff3f61a JH |
292 | |
293 | * documentation for release link:v1.4.4.4/git.html[1.4.4.4], | |
294 | link:v1.3.3/git.html[1.3.3], | |
295 | link:v1.2.6/git.html[1.2.6], | |
296 | link:v1.0.13/git.html[1.0.13]. | |
26cfcfbf JH |
297 | |
298 | ============ | |
299 | ||
300 | endif::stalenotes[] | |
301 | ||
cb22bc44 AE |
302 | OPTIONS |
303 | ------- | |
304 | --version:: | |
a87cd02c | 305 | Prints the git suite version that the 'git' program came from. |
cb22bc44 AE |
306 | |
307 | --help:: | |
a87cd02c | 308 | Prints the synopsis and a list of the most commonly used |
0f6f195b CC |
309 | commands. If the option '--all' or '-a' is given then all |
310 | available commands are printed. If a git command is named this | |
311 | option will bring up the manual page for that command. | |
45533d26 CC |
312 | + |
313 | Other options are available to control how the manual page is | |
5162e697 | 314 | displayed. See linkgit:git-help[1] for more information, |
db5d6666 JN |
315 | because `git --help ...` is converted internally into `git |
316 | help ...`. | |
cb22bc44 | 317 | |
8b1fa778 AR |
318 | -c <name>=<value>:: |
319 | Pass a configuration parameter to the command. The value | |
320 | given will override values from configuration files. | |
321 | The <name> is expected in the same format as listed by | |
322 | 'git config' (subkeys separated by dots). | |
323 | ||
62b4698e | 324 | --exec-path[=<path>]:: |
a87cd02c | 325 | Path to wherever your core git programs are installed. |
cb22bc44 | 326 | This can also be controlled by setting the GIT_EXEC_PATH |
56992f76 | 327 | environment variable. If no path is given, 'git' will print |
cb22bc44 AE |
328 | the current setting and then exit. |
329 | ||
89a56bfb | 330 | --html-path:: |
239b5ed9 JN |
331 | Print the path, without trailing slash, where git's HTML |
332 | documentation is installed and exit. | |
89a56bfb | 333 | |
f2dd8c37 | 334 | --man-path:: |
239b5ed9 JN |
335 | Print the manpath (see `man(1)`) for the man pages for |
336 | this version of git and exit. | |
f2dd8c37 JS |
337 | |
338 | --info-path:: | |
239b5ed9 JN |
339 | Print the path where the Info files documenting this |
340 | version of git are installed and exit. | |
89a56bfb | 341 | |
3240240f SB |
342 | -p:: |
343 | --paginate:: | |
06300d97 JN |
344 | Pipe all output into 'less' (or if set, $PAGER) if standard |
345 | output is a terminal. This overrides the `pager.<cmd>` | |
346 | configuration options (see the "Configuration Mechanism" section | |
347 | below). | |
6acbcb92 | 348 | |
463a849d MM |
349 | --no-pager:: |
350 | Do not pipe git output into a pager. | |
351 | ||
6acbcb92 JS |
352 | --git-dir=<path>:: |
353 | Set the path to the repository. This can also be controlled by | |
302cc11a LY |
354 | setting the GIT_DIR environment variable. It can be an absolute |
355 | path or relative path to current working directory. | |
6acbcb92 | 356 | |
892c41b9 | 357 | --work-tree=<path>:: |
ea472c1e JH |
358 | Set the path to the working tree. It can be an absolute path |
359 | or a path relative to the current working directory. | |
892c41b9 ML |
360 | This can also be controlled by setting the GIT_WORK_TREE |
361 | environment variable and the core.worktree configuration | |
ea472c1e JH |
362 | variable (see core.worktree in linkgit:git-config[1] for a |
363 | more detailed discussion). | |
892c41b9 | 364 | |
d49483f0 JT |
365 | --namespace=<path>:: |
366 | Set the git namespace. See linkgit:gitnamespaces[7] for more | |
367 | details. Equivalent to setting the `GIT_NAMESPACE` environment | |
368 | variable. | |
369 | ||
6acbcb92 | 370 | --bare:: |
9277d602 JH |
371 | Treat the repository as a bare repository. If GIT_DIR |
372 | environment is not set, it is set to the current working | |
373 | directory. | |
374 | ||
b0fa7ab5 CC |
375 | --no-replace-objects:: |
376 | Do not use replacement refs to replace git objects. See | |
377 | linkgit:git-replace[1] for more information. | |
378 | ||
9755afbd | 379 | |
23091e95 BF |
380 | FURTHER DOCUMENTATION |
381 | --------------------- | |
9755afbd | 382 | |
23091e95 BF |
383 | See the references above to get started using git. The following is |
384 | probably more detail than necessary for a first-time user. | |
8db9307c | 385 | |
40dac517 | 386 | The link:user-manual.html#git-concepts[git concepts chapter of the |
6998e4db | 387 | user-manual] and linkgit:gitcore-tutorial[7] both provide |
40dac517 | 388 | introductions to the underlying git architecture. |
e6fc2346 | 389 | |
801a011d TR |
390 | See linkgit:gitworkflows[7] for an overview of recommended workflows. |
391 | ||
23091e95 BF |
392 | See also the link:howto-index.html[howto] documents for some useful |
393 | examples. | |
9755afbd | 394 | |
6998e4db JN |
395 | The internals are documented in the |
396 | link:technical/api-index.html[GIT API documentation]. | |
530e741c | 397 | |
23091e95 BF |
398 | GIT COMMANDS |
399 | ------------ | |
9755afbd | 400 | |
23091e95 BF |
401 | We divide git into high level ("porcelain") commands and low level |
402 | ("plumbing") commands. | |
8b15e2fb | 403 | |
23091e95 BF |
404 | High-level commands (porcelain) |
405 | ------------------------------- | |
406 | ||
407 | We separate the porcelain commands into the main commands and some | |
408 | ancillary user utilities. | |
409 | ||
410 | Main porcelain commands | |
411 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 412 | |
377e8139 | 413 | include::cmds-mainporcelain.txt[] |
e31bb3bb | 414 | |
90933efb | 415 | Ancillary Commands |
23091e95 | 416 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
417 | Manipulators: |
418 | ||
377e8139 | 419 | include::cmds-ancillarymanipulators.txt[] |
204ee6a9 | 420 | |
90933efb | 421 | Interrogators: |
204ee6a9 | 422 | |
377e8139 | 423 | include::cmds-ancillaryinterrogators.txt[] |
7fc9d69f | 424 | |
89bf2077 JH |
425 | |
426 | Interacting with Others | |
427 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
428 | ||
429 | These commands are to interact with foreign SCM and with other | |
430 | people via patch over e-mail. | |
431 | ||
432 | include::cmds-foreignscminterface.txt[] | |
433 | ||
434 | ||
b1f33d62 RR |
435 | Low-level commands (plumbing) |
436 | ----------------------------- | |
437 | ||
438 | Although git includes its | |
439 | own porcelain layer, its low-level commands are sufficient to support | |
440 | development of alternative porcelains. Developers of such porcelains | |
5162e697 DM |
441 | might start by reading about linkgit:git-update-index[1] and |
442 | linkgit:git-read-tree[1]. | |
b1f33d62 | 443 | |
89bf2077 JH |
444 | The interface (input, output, set of options and the semantics) |
445 | to these low-level commands are meant to be a lot more stable | |
446 | than Porcelain level commands, because these commands are | |
447 | primarily for scripted use. The interface to Porcelain commands | |
448 | on the other hand are subject to change in order to improve the | |
449 | end user experience. | |
450 | ||
451 | The following description divides | |
452 | the low-level commands into commands that manipulate objects (in | |
b1f33d62 RR |
453 | the repository, index, and working tree), commands that interrogate and |
454 | compare objects, and commands that move objects and references between | |
455 | repositories. | |
456 | ||
89bf2077 | 457 | |
b1f33d62 RR |
458 | Manipulation commands |
459 | ~~~~~~~~~~~~~~~~~~~~~ | |
b1f33d62 | 460 | |
377e8139 | 461 | include::cmds-plumbingmanipulators.txt[] |
b1f33d62 RR |
462 | |
463 | ||
464 | Interrogation commands | |
465 | ~~~~~~~~~~~~~~~~~~~~~~ | |
466 | ||
377e8139 | 467 | include::cmds-plumbinginterrogators.txt[] |
b1f33d62 RR |
468 | |
469 | In general, the interrogate commands do not touch the files in | |
470 | the working tree. | |
471 | ||
472 | ||
473 | Synching repositories | |
474 | ~~~~~~~~~~~~~~~~~~~~~ | |
475 | ||
377e8139 | 476 | include::cmds-synchingrepositories.txt[] |
b1f33d62 | 477 | |
57f6ec02 | 478 | The following are helper commands used by the above; end users |
89bf2077 JH |
479 | typically do not use them directly. |
480 | ||
481 | include::cmds-synchelpers.txt[] | |
482 | ||
483 | ||
484 | Internal helper commands | |
485 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
486 | ||
487 | These are internal helper commands used by other commands; end | |
488 | users typically do not use them directly. | |
489 | ||
490 | include::cmds-purehelpers.txt[] | |
491 | ||
b1f33d62 | 492 | |
5773c9f2 JH |
493 | Configuration Mechanism |
494 | ----------------------- | |
495 | ||
2fa090b6 | 496 | Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file |
5773c9f2 | 497 | is used to hold per-repository configuration options. It is a |
addf88e4 | 498 | simple text file modeled after `.ini` format familiar to some |
5773c9f2 JH |
499 | people. Here is an example: |
500 | ||
501 | ------------ | |
502 | # | |
2fa090b6 | 503 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
504 | # |
505 | ||
506 | ; core variables | |
507 | [core] | |
508 | ; Don't trust file modes | |
509 | filemode = false | |
510 | ||
511 | ; user identity | |
512 | [user] | |
513 | name = "Junio C Hamano" | |
514 | email = "junkio@twinsun.com" | |
515 | ||
516 | ------------ | |
517 | ||
518 | Various commands read from the configuration file and adjust | |
06300d97 JN |
519 | their operation accordingly. See linkgit:git-config[1] for a |
520 | list. | |
5773c9f2 JH |
521 | |
522 | ||
6c84e2e0 | 523 | Identifier Terminology |
2cf565c5 DG |
524 | ---------------------- |
525 | <object>:: | |
2fa090b6 | 526 | Indicates the object name for any type of object. |
2cf565c5 DG |
527 | |
528 | <blob>:: | |
2fa090b6 | 529 | Indicates a blob object name. |
2cf565c5 DG |
530 | |
531 | <tree>:: | |
2fa090b6 | 532 | Indicates a tree object name. |
2cf565c5 DG |
533 | |
534 | <commit>:: | |
2fa090b6 | 535 | Indicates a commit object name. |
2cf565c5 DG |
536 | |
537 | <tree-ish>:: | |
2fa090b6 | 538 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
539 | command that takes a <tree-ish> argument ultimately wants to |
540 | operate on a <tree> object but automatically dereferences | |
541 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 | 542 | |
043d7605 TT |
543 | <commit-ish>:: |
544 | Indicates a commit or tag object name. A | |
545 | command that takes a <commit-ish> argument ultimately wants to | |
546 | operate on a <commit> object but automatically dereferences | |
547 | <tag> objects that point at a <commit>. | |
548 | ||
2cf565c5 DG |
549 | <type>:: |
550 | Indicates that an object type is required. | |
2fa090b6 | 551 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
552 | |
553 | <file>:: | |
2fa090b6 JH |
554 | Indicates a filename - almost always relative to the |
555 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 556 | |
c1bdacf9 DG |
557 | Symbolic Identifiers |
558 | -------------------- | |
90933efb | 559 | Any git command accepting any <object> can also use the following |
6c84e2e0 | 560 | symbolic notation: |
c1bdacf9 DG |
561 | |
562 | HEAD:: | |
0abcfbff | 563 | indicates the head of the current branch. |
2fa090b6 | 564 | |
c1bdacf9 | 565 | <tag>:: |
2fa090b6 | 566 | a valid tag 'name' |
0abcfbff | 567 | (i.e. a `refs/tags/<tag>` reference). |
2fa090b6 | 568 | |
c1bdacf9 | 569 | <head>:: |
2fa090b6 | 570 | a valid head 'name' |
0abcfbff | 571 | (i.e. a `refs/heads/<head>` reference). |
2fa090b6 | 572 | |
d47107d8 | 573 | For a more complete list of ways to spell object names, see |
9d83e382 | 574 | "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]. |
d47107d8 | 575 | |
c1bdacf9 DG |
576 | |
577 | File/Directory Structure | |
578 | ------------------------ | |
c1bdacf9 | 579 | |
6998e4db | 580 | Please see the linkgit:gitrepository-layout[5] document. |
c1bdacf9 | 581 | |
6998e4db | 582 | Read linkgit:githooks[5] for more details about each hook. |
6250ad1e | 583 | |
c1bdacf9 | 584 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 585 | `$GIT_DIR`. |
c1bdacf9 | 586 | |
a1d4aa74 | 587 | |
2cf565c5 DG |
588 | Terminology |
589 | ----------- | |
6998e4db | 590 | Please see linkgit:gitglossary[7]. |
2cf565c5 DG |
591 | |
592 | ||
593 | Environment Variables | |
594 | --------------------- | |
595 | Various git commands use the following environment variables: | |
596 | ||
c1bdacf9 DG |
597 | The git Repository |
598 | ~~~~~~~~~~~~~~~~~~ | |
599 | These environment variables apply to 'all' core git commands. Nb: it | |
600 | is worth noting that they may be used/overridden by SCMS sitting above | |
2fa090b6 | 601 | git so take care if using Cogito etc. |
c1bdacf9 DG |
602 | |
603 | 'GIT_INDEX_FILE':: | |
604 | This environment allows the specification of an alternate | |
5f3aa197 LS |
605 | index file. If not specified, the default of `$GIT_DIR/index` |
606 | is used. | |
c1bdacf9 DG |
607 | |
608 | 'GIT_OBJECT_DIRECTORY':: | |
609 | If the object storage directory is specified via this | |
610 | environment variable then the sha1 directories are created | |
611 | underneath - otherwise the default `$GIT_DIR/objects` | |
612 | directory is used. | |
613 | ||
614 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
615 | Due to the immutable nature of git objects, old objects can be | |
616 | archived into shared, read-only directories. This variable | |
80ba074f JS |
617 | specifies a ":" separated (on Windows ";" separated) list |
618 | of git object directories which can be used to search for git | |
619 | objects. New objects will not be written to these directories. | |
c1bdacf9 DG |
620 | |
621 | 'GIT_DIR':: | |
2fa090b6 JH |
622 | If the 'GIT_DIR' environment variable is set then it |
623 | specifies a path to use instead of the default `.git` | |
624 | for the base of the repository. | |
c1bdacf9 | 625 | |
892c41b9 ML |
626 | 'GIT_WORK_TREE':: |
627 | Set the path to the working tree. The value will not be | |
628 | used in combination with repositories found automatically in | |
629 | a .git directory (i.e. $GIT_DIR is not set). | |
630 | This can also be controlled by the '--work-tree' command line | |
631 | option and the core.worktree configuration variable. | |
632 | ||
d49483f0 JT |
633 | 'GIT_NAMESPACE':: |
634 | Set the git namespace; see linkgit:gitnamespaces[7] for details. | |
635 | The '--namespace' command-line option also sets this value. | |
636 | ||
0454dd93 DR |
637 | 'GIT_CEILING_DIRECTORIES':: |
638 | This should be a colon-separated list of absolute paths. | |
639 | If set, it is a list of directories that git should not chdir | |
640 | up into while looking for a repository directory. | |
641 | It will not exclude the current working directory or | |
642 | a GIT_DIR set on the command line or in the environment. | |
643 | (Useful for excluding slow-loading network directories.) | |
644 | ||
cf87463e | 645 | 'GIT_DISCOVERY_ACROSS_FILESYSTEM':: |
e6405517 JH |
646 | When run in a directory that does not have ".git" repository |
647 | directory, git tries to find such a directory in the parent | |
648 | directories to find the top of the working tree, but by default it | |
649 | does not cross filesystem boundaries. This environment variable | |
cf87463e JH |
650 | can be set to true to tell git not to stop at filesystem |
651 | boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect | |
652 | an explicit repository directory set via 'GIT_DIR' or on the | |
653 | command line. | |
8030e442 | 654 | |
c1bdacf9 DG |
655 | git Commits |
656 | ~~~~~~~~~~~ | |
657 | 'GIT_AUTHOR_NAME':: | |
658 | 'GIT_AUTHOR_EMAIL':: | |
659 | 'GIT_AUTHOR_DATE':: | |
660 | 'GIT_COMMITTER_NAME':: | |
661 | 'GIT_COMMITTER_EMAIL':: | |
4e58bf97 | 662 | 'GIT_COMMITTER_DATE':: |
28a94f88 | 663 | 'EMAIL':: |
5162e697 | 664 | see linkgit:git-commit-tree[1] |
c1bdacf9 DG |
665 | |
666 | git Diffs | |
667 | ~~~~~~~~~ | |
d81ed1b5 | 668 | 'GIT_DIFF_OPTS':: |
fde97d8a SE |
669 | Only valid setting is "--unified=??" or "-u??" to set the |
670 | number of context lines shown when a unified diff is created. | |
671 | This takes precedence over any "-U" or "--unified" option | |
672 | value passed on the git diff command line. | |
673 | ||
d81ed1b5 | 674 | 'GIT_EXTERNAL_DIFF':: |
fde97d8a SE |
675 | When the environment variable 'GIT_EXTERNAL_DIFF' is set, the |
676 | program named by it is called, instead of the diff invocation | |
677 | described above. For a path that is added, removed, or modified, | |
678 | 'GIT_EXTERNAL_DIFF' is called with 7 parameters: | |
679 | ||
680 | path old-file old-hex old-mode new-file new-hex new-mode | |
681 | + | |
682 | where: | |
683 | ||
684 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the | |
685 | contents of <old|new>, | |
686 | <old|new>-hex:: are the 40-hexdigit SHA1 hashes, | |
687 | <old|new>-mode:: are the octal representation of the file modes. | |
fde97d8a SE |
688 | + |
689 | The file parameters can point at the user's working file | |
690 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` | |
691 | when a new file is added), or a temporary file (e.g. `old-file` in the | |
692 | index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the | |
693 | temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. | |
694 | + | |
695 | For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 | |
696 | parameter, <path>. | |
2cf565c5 | 697 | |
575ba9d6 ML |
698 | other |
699 | ~~~~~ | |
dbddb714 JN |
700 | 'GIT_MERGE_VERBOSITY':: |
701 | A number controlling the amount of output shown by | |
702 | the recursive merge strategy. Overrides merge.verbosity. | |
5162e697 | 703 | See linkgit:git-merge[1] |
dbddb714 | 704 | |
c27d205a | 705 | 'GIT_PAGER':: |
a7738c77 SG |
706 | This environment variable overrides `$PAGER`. If it is set |
707 | to an empty string or to the value "cat", git will not launch | |
ab54cd6c JN |
708 | a pager. See also the `core.pager` option in |
709 | linkgit:git-config[1]. | |
c27d205a | 710 | |
d5538b41 | 711 | 'GIT_SSH':: |
0b444cdb TR |
712 | If this environment variable is set then 'git fetch' |
713 | and 'git push' will use this command instead | |
2fd02c92 | 714 | of 'ssh' when they need to connect to a remote system. |
483bc4f0 | 715 | The '$GIT_SSH' command will be given exactly two arguments: |
d5538b41 SP |
716 | the 'username@host' (or just 'host') from the URL and the |
717 | shell command to execute on that remote system. | |
718 | + | |
719 | To pass options to the program that you want to list in GIT_SSH | |
720 | you will need to wrap the program and options into a shell script, | |
721 | then set GIT_SSH to refer to the shell script. | |
722 | + | |
723 | Usually it is easier to configure any desired options through your | |
724 | personal `.ssh/config` file. Please consult your ssh documentation | |
725 | for further details. | |
726 | ||
453842c9 KF |
727 | 'GIT_ASKPASS':: |
728 | If this environment variable is set, then git commands which need to | |
729 | acquire passwords or passphrases (e.g. for HTTP or IMAP authentication) | |
730 | will call this program with a suitable prompt as command line argument | |
731 | and read the password from its STDOUT. See also the 'core.askpass' | |
732 | option in linkgit:git-config[1]. | |
733 | ||
06f59e9f TT |
734 | 'GIT_FLUSH':: |
735 | If this environment variable is set to "1", then commands such | |
0b444cdb TR |
736 | as 'git blame' (in incremental mode), 'git rev-list', 'git log', |
737 | and 'git whatchanged' will force a flush of the output stream | |
06f59e9f TT |
738 | after each commit-oriented record have been flushed. If this |
739 | variable is set to "0", the output of these commands will be done | |
740 | using completely buffered I/O. If this environment variable is | |
741 | not set, git will choose buffered or record-oriented flushing | |
742 | based on whether stdout appears to be redirected to a file or not. | |
743 | ||
575ba9d6 | 744 | 'GIT_TRACE':: |
2886bdb1 CC |
745 | If this variable is set to "1", "2" or "true" (comparison |
746 | is case insensitive), git will print `trace:` messages on | |
575ba9d6 ML |
747 | stderr telling about alias expansion, built-in command |
748 | execution and external command execution. | |
2886bdb1 CC |
749 | If this variable is set to an integer value greater than 1 |
750 | and lower than 10 (strictly) then git will interpret this | |
751 | value as an open file descriptor and will try to write the | |
752 | trace messages into this file descriptor. | |
753 | Alternatively, if this variable is set to an absolute path | |
754 | (starting with a '/' character), git will interpret this | |
755 | as a file path and will try to write the trace messages | |
756 | into it. | |
575ba9d6 | 757 | |
8db9307c JH |
758 | Discussion[[Discussion]] |
759 | ------------------------ | |
40dac517 BF |
760 | |
761 | More detail on the following is available from the | |
762 | link:user-manual.html#git-concepts[git concepts chapter of the | |
6998e4db | 763 | user-manual] and linkgit:gitcore-tutorial[7]. |
40dac517 BF |
764 | |
765 | A git project normally consists of a working directory with a ".git" | |
766 | subdirectory at the top level. The .git directory contains, among other | |
767 | things, a compressed object database representing the complete history | |
768 | of the project, an "index" file which links that history to the current | |
769 | contents of the working tree, and named pointers into that history such | |
770 | as tags and branch heads. | |
771 | ||
772 | The object database contains objects of three main types: blobs, which | |
773 | hold file data; trees, which point to blobs and other trees to build up | |
02ff6250 | 774 | directory hierarchies; and commits, which each reference a single tree |
40dac517 BF |
775 | and some number of parent commits. |
776 | ||
777 | The commit, equivalent to what other systems call a "changeset" or | |
778 | "version", represents a step in the project's history, and each parent | |
779 | represents an immediately preceding step. Commits with more than one | |
780 | parent represent merges of independent lines of development. | |
781 | ||
782 | All objects are named by the SHA1 hash of their contents, normally | |
783 | written as a string of 40 hex digits. Such names are globally unique. | |
784 | The entire history leading up to a commit can be vouched for by signing | |
785 | just that commit. A fourth object type, the tag, is provided for this | |
786 | purpose. | |
787 | ||
788 | When first created, objects are stored in individual files, but for | |
789 | efficiency may later be compressed together into "pack files". | |
790 | ||
791 | Named pointers called refs mark interesting points in history. A ref | |
792 | may contain the SHA1 name of an object or the name of another ref. Refs | |
793 | with names beginning `ref/head/` contain the SHA1 name of the most | |
02ff6250 | 794 | recent commit (or "head") of a branch under development. SHA1 names of |
40dac517 BF |
795 | tags of interest are stored under `ref/tags/`. A special ref named |
796 | `HEAD` contains the name of the currently checked-out branch. | |
797 | ||
798 | The index file is initialized with a list of all paths and, for each | |
799 | path, a blob object and a set of attributes. The blob object represents | |
800 | the contents of the file as of the head of the current branch. The | |
801 | attributes (last modified time, size, etc.) are taken from the | |
802 | corresponding file in the working tree. Subsequent changes to the | |
803 | working tree can be found by comparing these attributes. The index may | |
804 | be updated with new content, and new commits may be created from the | |
805 | content stored in the index. | |
806 | ||
807 | The index is also capable of storing multiple entries (called "stages") | |
808 | for a given pathname. These stages are used to hold the various | |
809 | unmerged version of a file when a merge is in progress. | |
6c84e2e0 | 810 | |
cb22bc44 AE |
811 | Authors |
812 | ------- | |
48bb914e JK |
813 | Git was started by Linus Torvalds, and is currently maintained by Junio |
814 | C Hamano. Numerous contributions have come from the git mailing list | |
d8f708f8 JK |
815 | <git@vger.kernel.org>. For a more complete list of contributors, see |
816 | http://git-scm.com/about. If you have a clone of git.git itself, the | |
817 | output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you | |
818 | the authors for specific parts of the project. | |
2cf565c5 | 819 | |
c97ca277 JH |
820 | Reporting Bugs |
821 | -------------- | |
822 | ||
823 | Report bugs to the Git mailing list <git@vger.kernel.org> where the | |
824 | development and maintenance is primarily done. You do not have to be | |
825 | subscribed to the list to send a message there. | |
826 | ||
497c8331 CC |
827 | SEE ALSO |
828 | -------- | |
829 | linkgit:gittutorial[7], linkgit:gittutorial-2[7], | |
5cbef01a | 830 | link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7], |
497c8331 | 831 | linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], |
801a011d TR |
832 | linkgit:gitcli[7], link:user-manual.html[The Git User's Manual], |
833 | linkgit:gitworkflows[7] | |
497c8331 | 834 | |
2cf565c5 DG |
835 | GIT |
836 | --- | |
9e1f0a85 | 837 | Part of the linkgit:git[1] suite |