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