6 git - the stupid content tracker
12 'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
13 [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
14 [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
15 [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
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.
24 See linkgit:gittutorial[7] to get started, then see
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.
29 After you mastered the basic concepts, you can come back to this
30 page to learn what commands Git offers. You can learn more about
31 individual Git commands with "git help command". linkgit:gitcli[7]
32 manual page gives you an overview of the command line command syntax.
34 Formatted and hyperlinked version of the latest Git documentation
35 can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
41 You are reading the documentation for the latest (possibly
42 unreleased) version of Git, that is available from 'master'
43 branch of the `git.git` repository.
44 Documentation for older releases are available here:
46 * link:v1.8.5/git.html[documentation for release 1.8.5]
49 link:RelNotes/1.8.5.txt[1.8.5].
51 * link:v1.8.4.4/git.html[documentation for release 1.8.4.4]
54 link:RelNotes/1.8.4.4.txt[1.8.4.4],
55 link:RelNotes/1.8.4.3.txt[1.8.4.3],
56 link:RelNotes/1.8.4.2.txt[1.8.4.2],
57 link:RelNotes/1.8.4.1.txt[1.8.4.1],
58 link:RelNotes/1.8.4.txt[1.8.4].
60 * link:v1.8.3.4/git.html[documentation for release 1.8.3.4]
63 link:RelNotes/1.8.3.4.txt[1.8.3.4],
64 link:RelNotes/1.8.3.3.txt[1.8.3.3],
65 link:RelNotes/1.8.3.2.txt[1.8.3.2],
66 link:RelNotes/1.8.3.1.txt[1.8.3.1],
67 link:RelNotes/1.8.3.txt[1.8.3].
69 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
72 link:RelNotes/1.8.2.3.txt[1.8.2.3],
73 link:RelNotes/1.8.2.2.txt[1.8.2.2],
74 link:RelNotes/1.8.2.1.txt[1.8.2.1],
75 link:RelNotes/1.8.2.txt[1.8.2].
77 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
80 link:RelNotes/1.8.1.6.txt[1.8.1.6],
81 link:RelNotes/1.8.1.5.txt[1.8.1.5],
82 link:RelNotes/1.8.1.4.txt[1.8.1.4],
83 link:RelNotes/1.8.1.3.txt[1.8.1.3],
84 link:RelNotes/1.8.1.2.txt[1.8.1.2],
85 link:RelNotes/1.8.1.1.txt[1.8.1.1],
86 link:RelNotes/1.8.1.txt[1.8.1].
88 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
91 link:RelNotes/1.8.0.3.txt[1.8.0.3],
92 link:RelNotes/1.8.0.2.txt[1.8.0.2],
93 link:RelNotes/1.8.0.1.txt[1.8.0.1],
94 link:RelNotes/1.8.0.txt[1.8.0].
96 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
99 link:RelNotes/1.7.12.4.txt[1.7.12.4],
100 link:RelNotes/1.7.12.3.txt[1.7.12.3],
101 link:RelNotes/1.7.12.2.txt[1.7.12.2],
102 link:RelNotes/1.7.12.1.txt[1.7.12.1],
103 link:RelNotes/1.7.12.txt[1.7.12].
105 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
108 link:RelNotes/1.7.11.7.txt[1.7.11.7],
109 link:RelNotes/1.7.11.6.txt[1.7.11.6],
110 link:RelNotes/1.7.11.5.txt[1.7.11.5],
111 link:RelNotes/1.7.11.4.txt[1.7.11.4],
112 link:RelNotes/1.7.11.3.txt[1.7.11.3],
113 link:RelNotes/1.7.11.2.txt[1.7.11.2],
114 link:RelNotes/1.7.11.1.txt[1.7.11.1],
115 link:RelNotes/1.7.11.txt[1.7.11].
117 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
120 link:RelNotes/1.7.10.5.txt[1.7.10.5],
121 link:RelNotes/1.7.10.4.txt[1.7.10.4],
122 link:RelNotes/1.7.10.3.txt[1.7.10.3],
123 link:RelNotes/1.7.10.2.txt[1.7.10.2],
124 link:RelNotes/1.7.10.1.txt[1.7.10.1],
125 link:RelNotes/1.7.10.txt[1.7.10].
127 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
130 link:RelNotes/1.7.9.7.txt[1.7.9.7],
131 link:RelNotes/1.7.9.6.txt[1.7.9.6],
132 link:RelNotes/1.7.9.5.txt[1.7.9.5],
133 link:RelNotes/1.7.9.4.txt[1.7.9.4],
134 link:RelNotes/1.7.9.3.txt[1.7.9.3],
135 link:RelNotes/1.7.9.2.txt[1.7.9.2],
136 link:RelNotes/1.7.9.1.txt[1.7.9.1],
137 link:RelNotes/1.7.9.txt[1.7.9].
139 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
142 link:RelNotes/1.7.8.6.txt[1.7.8.6],
143 link:RelNotes/1.7.8.5.txt[1.7.8.5],
144 link:RelNotes/1.7.8.4.txt[1.7.8.4],
145 link:RelNotes/1.7.8.3.txt[1.7.8.3],
146 link:RelNotes/1.7.8.2.txt[1.7.8.2],
147 link:RelNotes/1.7.8.1.txt[1.7.8.1],
148 link:RelNotes/1.7.8.txt[1.7.8].
150 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
153 link:RelNotes/1.7.7.7.txt[1.7.7.7],
154 link:RelNotes/1.7.7.6.txt[1.7.7.6],
155 link:RelNotes/1.7.7.5.txt[1.7.7.5],
156 link:RelNotes/1.7.7.4.txt[1.7.7.4],
157 link:RelNotes/1.7.7.3.txt[1.7.7.3],
158 link:RelNotes/1.7.7.2.txt[1.7.7.2],
159 link:RelNotes/1.7.7.1.txt[1.7.7.1],
160 link:RelNotes/1.7.7.txt[1.7.7].
162 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
165 link:RelNotes/1.7.6.6.txt[1.7.6.6],
166 link:RelNotes/1.7.6.5.txt[1.7.6.5],
167 link:RelNotes/1.7.6.4.txt[1.7.6.4],
168 link:RelNotes/1.7.6.3.txt[1.7.6.3],
169 link:RelNotes/1.7.6.2.txt[1.7.6.2],
170 link:RelNotes/1.7.6.1.txt[1.7.6.1],
171 link:RelNotes/1.7.6.txt[1.7.6].
173 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
176 link:RelNotes/1.7.5.4.txt[1.7.5.4],
177 link:RelNotes/1.7.5.3.txt[1.7.5.3],
178 link:RelNotes/1.7.5.2.txt[1.7.5.2],
179 link:RelNotes/1.7.5.1.txt[1.7.5.1],
180 link:RelNotes/1.7.5.txt[1.7.5].
182 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
185 link:RelNotes/1.7.4.5.txt[1.7.4.5],
186 link:RelNotes/1.7.4.4.txt[1.7.4.4],
187 link:RelNotes/1.7.4.3.txt[1.7.4.3],
188 link:RelNotes/1.7.4.2.txt[1.7.4.2],
189 link:RelNotes/1.7.4.1.txt[1.7.4.1],
190 link:RelNotes/1.7.4.txt[1.7.4].
192 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
195 link:RelNotes/1.7.3.5.txt[1.7.3.5],
196 link:RelNotes/1.7.3.4.txt[1.7.3.4],
197 link:RelNotes/1.7.3.3.txt[1.7.3.3],
198 link:RelNotes/1.7.3.2.txt[1.7.3.2],
199 link:RelNotes/1.7.3.1.txt[1.7.3.1],
200 link:RelNotes/1.7.3.txt[1.7.3].
202 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
205 link:RelNotes/1.7.2.5.txt[1.7.2.5],
206 link:RelNotes/1.7.2.4.txt[1.7.2.4],
207 link:RelNotes/1.7.2.3.txt[1.7.2.3],
208 link:RelNotes/1.7.2.2.txt[1.7.2.2],
209 link:RelNotes/1.7.2.1.txt[1.7.2.1],
210 link:RelNotes/1.7.2.txt[1.7.2].
212 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
215 link:RelNotes/1.7.1.4.txt[1.7.1.4],
216 link:RelNotes/1.7.1.3.txt[1.7.1.3],
217 link:RelNotes/1.7.1.2.txt[1.7.1.2],
218 link:RelNotes/1.7.1.1.txt[1.7.1.1],
219 link:RelNotes/1.7.1.txt[1.7.1].
221 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
224 link:RelNotes/1.7.0.9.txt[1.7.0.9],
225 link:RelNotes/1.7.0.8.txt[1.7.0.8],
226 link:RelNotes/1.7.0.7.txt[1.7.0.7],
227 link:RelNotes/1.7.0.6.txt[1.7.0.6],
228 link:RelNotes/1.7.0.5.txt[1.7.0.5],
229 link:RelNotes/1.7.0.4.txt[1.7.0.4],
230 link:RelNotes/1.7.0.3.txt[1.7.0.3],
231 link:RelNotes/1.7.0.2.txt[1.7.0.2],
232 link:RelNotes/1.7.0.1.txt[1.7.0.1],
233 link:RelNotes/1.7.0.txt[1.7.0].
235 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
238 link:RelNotes/1.6.6.3.txt[1.6.6.3],
239 link:RelNotes/1.6.6.2.txt[1.6.6.2],
240 link:RelNotes/1.6.6.1.txt[1.6.6.1],
241 link:RelNotes/1.6.6.txt[1.6.6].
243 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
246 link:RelNotes/1.6.5.9.txt[1.6.5.9],
247 link:RelNotes/1.6.5.8.txt[1.6.5.8],
248 link:RelNotes/1.6.5.7.txt[1.6.5.7],
249 link:RelNotes/1.6.5.6.txt[1.6.5.6],
250 link:RelNotes/1.6.5.5.txt[1.6.5.5],
251 link:RelNotes/1.6.5.4.txt[1.6.5.4],
252 link:RelNotes/1.6.5.3.txt[1.6.5.3],
253 link:RelNotes/1.6.5.2.txt[1.6.5.2],
254 link:RelNotes/1.6.5.1.txt[1.6.5.1],
255 link:RelNotes/1.6.5.txt[1.6.5].
257 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
260 link:RelNotes/1.6.4.5.txt[1.6.4.5],
261 link:RelNotes/1.6.4.4.txt[1.6.4.4],
262 link:RelNotes/1.6.4.3.txt[1.6.4.3],
263 link:RelNotes/1.6.4.2.txt[1.6.4.2],
264 link:RelNotes/1.6.4.1.txt[1.6.4.1],
265 link:RelNotes/1.6.4.txt[1.6.4].
267 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
270 link:RelNotes/1.6.3.4.txt[1.6.3.4],
271 link:RelNotes/1.6.3.3.txt[1.6.3.3],
272 link:RelNotes/1.6.3.2.txt[1.6.3.2],
273 link:RelNotes/1.6.3.1.txt[1.6.3.1],
274 link:RelNotes/1.6.3.txt[1.6.3].
277 link:RelNotes/1.6.2.5.txt[1.6.2.5],
278 link:RelNotes/1.6.2.4.txt[1.6.2.4],
279 link:RelNotes/1.6.2.3.txt[1.6.2.3],
280 link:RelNotes/1.6.2.2.txt[1.6.2.2],
281 link:RelNotes/1.6.2.1.txt[1.6.2.1],
282 link:RelNotes/1.6.2.txt[1.6.2].
284 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
287 link:RelNotes/1.6.1.3.txt[1.6.1.3],
288 link:RelNotes/1.6.1.2.txt[1.6.1.2],
289 link:RelNotes/1.6.1.1.txt[1.6.1.1],
290 link:RelNotes/1.6.1.txt[1.6.1].
292 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
295 link:RelNotes/1.6.0.6.txt[1.6.0.6],
296 link:RelNotes/1.6.0.5.txt[1.6.0.5],
297 link:RelNotes/1.6.0.4.txt[1.6.0.4],
298 link:RelNotes/1.6.0.3.txt[1.6.0.3],
299 link:RelNotes/1.6.0.2.txt[1.6.0.2],
300 link:RelNotes/1.6.0.1.txt[1.6.0.1],
301 link:RelNotes/1.6.0.txt[1.6.0].
303 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
306 link:RelNotes/1.5.6.6.txt[1.5.6.6],
307 link:RelNotes/1.5.6.5.txt[1.5.6.5],
308 link:RelNotes/1.5.6.4.txt[1.5.6.4],
309 link:RelNotes/1.5.6.3.txt[1.5.6.3],
310 link:RelNotes/1.5.6.2.txt[1.5.6.2],
311 link:RelNotes/1.5.6.1.txt[1.5.6.1],
312 link:RelNotes/1.5.6.txt[1.5.6].
314 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
317 link:RelNotes/1.5.5.6.txt[1.5.5.6],
318 link:RelNotes/1.5.5.5.txt[1.5.5.5],
319 link:RelNotes/1.5.5.4.txt[1.5.5.4],
320 link:RelNotes/1.5.5.3.txt[1.5.5.3],
321 link:RelNotes/1.5.5.2.txt[1.5.5.2],
322 link:RelNotes/1.5.5.1.txt[1.5.5.1],
323 link:RelNotes/1.5.5.txt[1.5.5].
325 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
328 link:RelNotes/1.5.4.7.txt[1.5.4.7],
329 link:RelNotes/1.5.4.6.txt[1.5.4.6],
330 link:RelNotes/1.5.4.5.txt[1.5.4.5],
331 link:RelNotes/1.5.4.4.txt[1.5.4.4],
332 link:RelNotes/1.5.4.3.txt[1.5.4.3],
333 link:RelNotes/1.5.4.2.txt[1.5.4.2],
334 link:RelNotes/1.5.4.1.txt[1.5.4.1],
335 link:RelNotes/1.5.4.txt[1.5.4].
337 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
340 link:RelNotes/1.5.3.8.txt[1.5.3.8],
341 link:RelNotes/1.5.3.7.txt[1.5.3.7],
342 link:RelNotes/1.5.3.6.txt[1.5.3.6],
343 link:RelNotes/1.5.3.5.txt[1.5.3.5],
344 link:RelNotes/1.5.3.4.txt[1.5.3.4],
345 link:RelNotes/1.5.3.3.txt[1.5.3.3],
346 link:RelNotes/1.5.3.2.txt[1.5.3.2],
347 link:RelNotes/1.5.3.1.txt[1.5.3.1],
348 link:RelNotes/1.5.3.txt[1.5.3].
350 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
353 link:RelNotes/1.5.2.5.txt[1.5.2.5],
354 link:RelNotes/1.5.2.4.txt[1.5.2.4],
355 link:RelNotes/1.5.2.3.txt[1.5.2.3],
356 link:RelNotes/1.5.2.2.txt[1.5.2.2],
357 link:RelNotes/1.5.2.1.txt[1.5.2.1],
358 link:RelNotes/1.5.2.txt[1.5.2].
360 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
363 link:RelNotes/1.5.1.6.txt[1.5.1.6],
364 link:RelNotes/1.5.1.5.txt[1.5.1.5],
365 link:RelNotes/1.5.1.4.txt[1.5.1.4],
366 link:RelNotes/1.5.1.3.txt[1.5.1.3],
367 link:RelNotes/1.5.1.2.txt[1.5.1.2],
368 link:RelNotes/1.5.1.1.txt[1.5.1.1],
369 link:RelNotes/1.5.1.txt[1.5.1].
371 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
374 link:RelNotes/1.5.0.7.txt[1.5.0.7],
375 link:RelNotes/1.5.0.6.txt[1.5.0.6],
376 link:RelNotes/1.5.0.5.txt[1.5.0.5],
377 link:RelNotes/1.5.0.3.txt[1.5.0.3],
378 link:RelNotes/1.5.0.2.txt[1.5.0.2],
379 link:RelNotes/1.5.0.1.txt[1.5.0.1],
380 link:RelNotes/1.5.0.txt[1.5.0].
382 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
383 link:v1.3.3/git.html[1.3.3],
384 link:v1.2.6/git.html[1.2.6],
385 link:v1.0.13/git.html[1.0.13].
394 Prints the Git suite version that the 'git' program came from.
397 Prints the synopsis and a list of the most commonly used
398 commands. If the option '--all' or '-a' is given then all
399 available commands are printed. If a Git command is named this
400 option will bring up the manual page for that command.
402 Other options are available to control how the manual page is
403 displayed. See linkgit:git-help[1] for more information,
404 because `git --help ...` is converted internally into `git
408 Run as if git was started in '<path>' instead of the current working
409 directory. When multiple `-C` options are given, each subsequent
410 non-absolute `-C <path>` is interpreted relative to the preceding `-C
413 This option affects options that expect path name like `--git-dir` and
414 `--work-tree` in that their interpretations of the path names would be
415 made relative to the working directory caused by the `-C` option. For
416 example the following invocations are equivalent:
418 git --git-dir=a.git --work-tree=b -C c status
419 git --git-dir=c/a.git --work-tree=c/b status
422 Pass a configuration parameter to the command. The value
423 given will override values from configuration files.
424 The <name> is expected in the same format as listed by
425 'git config' (subkeys separated by dots).
427 --exec-path[=<path>]::
428 Path to wherever your core Git programs are installed.
429 This can also be controlled by setting the GIT_EXEC_PATH
430 environment variable. If no path is given, 'git' will print
431 the current setting and then exit.
434 Print the path, without trailing slash, where Git's HTML
435 documentation is installed and exit.
438 Print the manpath (see `man(1)`) for the man pages for
439 this version of Git and exit.
442 Print the path where the Info files documenting this
443 version of Git are installed and exit.
447 Pipe all output into 'less' (or if set, $PAGER) if standard
448 output is a terminal. This overrides the `pager.<cmd>`
449 configuration options (see the "Configuration Mechanism" section
453 Do not pipe Git output into a pager.
456 Set the path to the repository. This can also be controlled by
457 setting the GIT_DIR environment variable. It can be an absolute
458 path or relative path to current working directory.
461 Set the path to the working tree. It can be an absolute path
462 or a path relative to the current working directory.
463 This can also be controlled by setting the GIT_WORK_TREE
464 environment variable and the core.worktree configuration
465 variable (see core.worktree in linkgit:git-config[1] for a
466 more detailed discussion).
469 Set the Git namespace. See linkgit:gitnamespaces[7] for more
470 details. Equivalent to setting the `GIT_NAMESPACE` environment
474 Treat the repository as a bare repository. If GIT_DIR
475 environment is not set, it is set to the current working
478 --no-replace-objects::
479 Do not use replacement refs to replace Git objects. See
480 linkgit:git-replace[1] for more information.
482 --literal-pathspecs::
483 Treat pathspecs literally (i.e. no globbing, no pathspec magic).
484 This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
488 Add "glob" magic to all pathspec. This is equivalent to setting
489 the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
490 globbing on individual pathspecs can be done using pathspec
494 Add "literal" magic to all pathspec. This is equivalent to setting
495 the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
496 globbing on individual pathspecs can be done using pathspec
500 Add "icase" magic to all pathspec. This is equivalent to setting
501 the `GIT_ICASE_PATHSPECS` environment variable to `1`.
506 We divide Git into high level ("porcelain") commands and low level
507 ("plumbing") commands.
509 High-level commands (porcelain)
510 -------------------------------
512 We separate the porcelain commands into the main commands and some
513 ancillary user utilities.
515 Main porcelain commands
516 ~~~~~~~~~~~~~~~~~~~~~~~
518 include::cmds-mainporcelain.txt[]
524 include::cmds-ancillarymanipulators.txt[]
528 include::cmds-ancillaryinterrogators.txt[]
531 Interacting with Others
532 ~~~~~~~~~~~~~~~~~~~~~~~
534 These commands are to interact with foreign SCM and with other
535 people via patch over e-mail.
537 include::cmds-foreignscminterface.txt[]
540 Low-level commands (plumbing)
541 -----------------------------
543 Although Git includes its
544 own porcelain layer, its low-level commands are sufficient to support
545 development of alternative porcelains. Developers of such porcelains
546 might start by reading about linkgit:git-update-index[1] and
547 linkgit:git-read-tree[1].
549 The interface (input, output, set of options and the semantics)
550 to these low-level commands are meant to be a lot more stable
551 than Porcelain level commands, because these commands are
552 primarily for scripted use. The interface to Porcelain commands
553 on the other hand are subject to change in order to improve the
556 The following description divides
557 the low-level commands into commands that manipulate objects (in
558 the repository, index, and working tree), commands that interrogate and
559 compare objects, and commands that move objects and references between
563 Manipulation commands
564 ~~~~~~~~~~~~~~~~~~~~~
566 include::cmds-plumbingmanipulators.txt[]
569 Interrogation commands
570 ~~~~~~~~~~~~~~~~~~~~~~
572 include::cmds-plumbinginterrogators.txt[]
574 In general, the interrogate commands do not touch the files in
578 Synching repositories
579 ~~~~~~~~~~~~~~~~~~~~~
581 include::cmds-synchingrepositories.txt[]
583 The following are helper commands used by the above; end users
584 typically do not use them directly.
586 include::cmds-synchelpers.txt[]
589 Internal helper commands
590 ~~~~~~~~~~~~~~~~~~~~~~~~
592 These are internal helper commands used by other commands; end
593 users typically do not use them directly.
595 include::cmds-purehelpers.txt[]
598 Configuration Mechanism
599 -----------------------
601 Git uses a simple text format to store customizations that are per
602 repository and are per user. Such a configuration file may look
607 # A '#' or ';' character indicates a comment.
612 ; Don't trust file modes
617 name = "Junio C Hamano"
618 email = "gitster@pobox.com"
622 Various commands read from the configuration file and adjust
623 their operation accordingly. See linkgit:git-config[1] for a
624 list and more details about the configuration mechanism.
627 Identifier Terminology
628 ----------------------
630 Indicates the object name for any type of object.
633 Indicates a blob object name.
636 Indicates a tree object name.
639 Indicates a commit object name.
642 Indicates a tree, commit or tag object name. A
643 command that takes a <tree-ish> argument ultimately wants to
644 operate on a <tree> object but automatically dereferences
645 <commit> and <tag> objects that point at a <tree>.
648 Indicates a commit or tag object name. A
649 command that takes a <commit-ish> argument ultimately wants to
650 operate on a <commit> object but automatically dereferences
651 <tag> objects that point at a <commit>.
654 Indicates that an object type is required.
655 Currently one of: `blob`, `tree`, `commit`, or `tag`.
658 Indicates a filename - almost always relative to the
659 root of the tree structure `GIT_INDEX_FILE` describes.
663 Any Git command accepting any <object> can also use the following
667 indicates the head of the current branch.
671 (i.e. a `refs/tags/<tag>` reference).
675 (i.e. a `refs/heads/<head>` reference).
677 For a more complete list of ways to spell object names, see
678 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
681 File/Directory Structure
682 ------------------------
684 Please see the linkgit:gitrepository-layout[5] document.
686 Read linkgit:githooks[5] for more details about each hook.
688 Higher level SCMs may provide and manage additional information in the
694 Please see linkgit:gitglossary[7].
697 Environment Variables
698 ---------------------
699 Various Git commands use the following environment variables:
703 These environment variables apply to 'all' core Git commands. Nb: it
704 is worth noting that they may be used/overridden by SCMS sitting above
705 Git so take care if using Cogito etc.
708 This environment allows the specification of an alternate
709 index file. If not specified, the default of `$GIT_DIR/index`
712 'GIT_OBJECT_DIRECTORY'::
713 If the object storage directory is specified via this
714 environment variable then the sha1 directories are created
715 underneath - otherwise the default `$GIT_DIR/objects`
718 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
719 Due to the immutable nature of Git objects, old objects can be
720 archived into shared, read-only directories. This variable
721 specifies a ":" separated (on Windows ";" separated) list
722 of Git object directories which can be used to search for Git
723 objects. New objects will not be written to these directories.
726 If the 'GIT_DIR' environment variable is set then it
727 specifies a path to use instead of the default `.git`
728 for the base of the repository.
729 The '--git-dir' command-line option also sets this value.
732 Set the path to the root of the working tree.
733 This can also be controlled by the '--work-tree' command line
734 option and the core.worktree configuration variable.
737 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
738 The '--namespace' command-line option also sets this value.
740 'GIT_CEILING_DIRECTORIES'::
741 This should be a colon-separated list of absolute paths. If
742 set, it is a list of directories that Git should not chdir up
743 into while looking for a repository directory (useful for
744 excluding slow-loading network directories). It will not
745 exclude the current working directory or a GIT_DIR set on the
746 command line or in the environment. Normally, Git has to read
747 the entries in this list and resolve any symlink that
748 might be present in order to compare them with the current
749 directory. However, if even this access is slow, you
750 can add an empty entry to the list to tell Git that the
751 subsequent entries are not symlinks and needn't be resolved;
753 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
755 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
756 When run in a directory that does not have ".git" repository
757 directory, Git tries to find such a directory in the parent
758 directories to find the top of the working tree, but by default it
759 does not cross filesystem boundaries. This environment variable
760 can be set to true to tell Git not to stop at filesystem
761 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
762 an explicit repository directory set via 'GIT_DIR' or on the
770 'GIT_COMMITTER_NAME'::
771 'GIT_COMMITTER_EMAIL'::
772 'GIT_COMMITTER_DATE'::
774 see linkgit:git-commit-tree[1]
779 Only valid setting is "--unified=??" or "-u??" to set the
780 number of context lines shown when a unified diff is created.
781 This takes precedence over any "-U" or "--unified" option
782 value passed on the Git diff command line.
784 'GIT_EXTERNAL_DIFF'::
785 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
786 program named by it is called, instead of the diff invocation
787 described above. For a path that is added, removed, or modified,
788 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
790 path old-file old-hex old-mode new-file new-hex new-mode
794 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
795 contents of <old|new>,
796 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
797 <old|new>-mode:: are the octal representation of the file modes.
799 The file parameters can point at the user's working file
800 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
801 when a new file is added), or a temporary file (e.g. `old-file` in the
802 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
803 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
805 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
810 'GIT_MERGE_VERBOSITY'::
811 A number controlling the amount of output shown by
812 the recursive merge strategy. Overrides merge.verbosity.
813 See linkgit:git-merge[1]
816 This environment variable overrides `$PAGER`. If it is set
817 to an empty string or to the value "cat", Git will not launch
818 a pager. See also the `core.pager` option in
819 linkgit:git-config[1].
822 This environment variable overrides `$EDITOR` and `$VISUAL`.
823 It is used by several Git commands when, on interactive mode,
824 an editor is to be launched. See also linkgit:git-var[1]
825 and the `core.editor` option in linkgit:git-config[1].
828 If this environment variable is set then 'git fetch'
829 and 'git push' will use this command instead
830 of 'ssh' when they need to connect to a remote system.
831 The '$GIT_SSH' command will be given exactly two or
832 four arguments: the 'username@host' (or just 'host')
833 from the URL and the shell command to execute on that
834 remote system, optionally preceded by '-p' (literally) and
835 the 'port' from the URL when it specifies something other
836 than the default SSH port.
838 To pass options to the program that you want to list in GIT_SSH
839 you will need to wrap the program and options into a shell script,
840 then set GIT_SSH to refer to the shell script.
842 Usually it is easier to configure any desired options through your
843 personal `.ssh/config` file. Please consult your ssh documentation
847 If this environment variable is set, then Git commands which need to
848 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
849 will call this program with a suitable prompt as command line argument
850 and read the password from its STDOUT. See also the 'core.askpass'
851 option in linkgit:git-config[1].
853 'GIT_CONFIG_NOSYSTEM'::
854 Whether to skip reading settings from the system-wide
855 `$(prefix)/etc/gitconfig` file. This environment variable can
856 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
857 predictable environment for a picky script, or you can set it
858 temporarily to avoid using a buggy `/etc/gitconfig` file while
859 waiting for someone with sufficient permissions to fix it.
862 If this environment variable is set to "1", then commands such
863 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
864 'git check-attr' and 'git check-ignore' will
865 force a flush of the output stream after each record have been
867 variable is set to "0", the output of these commands will be done
868 using completely buffered I/O. If this environment variable is
869 not set, Git will choose buffered or record-oriented flushing
870 based on whether stdout appears to be redirected to a file or not.
873 If this variable is set to "1", "2" or "true" (comparison
874 is case insensitive), Git will print `trace:` messages on
875 stderr telling about alias expansion, built-in command
876 execution and external command execution.
877 If this variable is set to an integer value greater than 1
878 and lower than 10 (strictly) then Git will interpret this
879 value as an open file descriptor and will try to write the
880 trace messages into this file descriptor.
881 Alternatively, if this variable is set to an absolute path
882 (starting with a '/' character), Git will interpret this
883 as a file path and will try to write the trace messages
886 'GIT_TRACE_PACK_ACCESS'::
887 If this variable is set to a path, a file will be created at
888 the given path logging all accesses to any packs. For each
889 access, the pack file name and an offset in the pack is
890 recorded. This may be helpful for troubleshooting some
891 pack-related performance problems.
894 If this variable is set, it shows a trace of all packets
895 coming in or out of a given program. This can help with
896 debugging object negotiation or other protocol issues. Tracing
897 is turned off at a packet starting with "PACK".
899 GIT_LITERAL_PATHSPECS::
900 Setting this variable to `1` will cause Git to treat all
901 pathspecs literally, rather than as glob patterns. For example,
902 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
903 for commits that touch the path `*.c`, not any paths that the
904 glob `*.c` matches. You might want this if you are feeding
905 literal paths to Git (e.g., paths previously given to you by
906 `git ls-tree`, `--raw` diff output, etc).
909 Setting this variable to `1` will cause Git to treat all
910 pathspecs as glob patterns (aka "glob" magic).
912 GIT_NOGLOB_PATHSPECS::
913 Setting this variable to `1` will cause Git to treat all
914 pathspecs as literal (aka "literal" magic).
916 GIT_ICASE_PATHSPECS::
917 Setting this variable to `1` will cause Git to treat all
918 pathspecs as case-insensitive.
920 'GIT_REFLOG_ACTION'::
921 When a ref is updated, reflog entries are created to keep
922 track of the reason why the ref was updated (which is
923 typically the name of the high-level command that updated
924 the ref), in addition to the old and new values of the ref.
925 A scripted Porcelain command can use set_reflog_action
926 helper function in `git-sh-setup` to set its name to this
927 variable when it is invoked as the top level command by the
928 end user, to be recorded in the body of the reflog.
931 Discussion[[Discussion]]
932 ------------------------
934 More detail on the following is available from the
935 link:user-manual.html#git-concepts[Git concepts chapter of the
936 user-manual] and linkgit:gitcore-tutorial[7].
938 A Git project normally consists of a working directory with a ".git"
939 subdirectory at the top level. The .git directory contains, among other
940 things, a compressed object database representing the complete history
941 of the project, an "index" file which links that history to the current
942 contents of the working tree, and named pointers into that history such
943 as tags and branch heads.
945 The object database contains objects of three main types: blobs, which
946 hold file data; trees, which point to blobs and other trees to build up
947 directory hierarchies; and commits, which each reference a single tree
948 and some number of parent commits.
950 The commit, equivalent to what other systems call a "changeset" or
951 "version", represents a step in the project's history, and each parent
952 represents an immediately preceding step. Commits with more than one
953 parent represent merges of independent lines of development.
955 All objects are named by the SHA-1 hash of their contents, normally
956 written as a string of 40 hex digits. Such names are globally unique.
957 The entire history leading up to a commit can be vouched for by signing
958 just that commit. A fourth object type, the tag, is provided for this
961 When first created, objects are stored in individual files, but for
962 efficiency may later be compressed together into "pack files".
964 Named pointers called refs mark interesting points in history. A ref
965 may contain the SHA-1 name of an object or the name of another ref. Refs
966 with names beginning `ref/head/` contain the SHA-1 name of the most
967 recent commit (or "head") of a branch under development. SHA-1 names of
968 tags of interest are stored under `ref/tags/`. A special ref named
969 `HEAD` contains the name of the currently checked-out branch.
971 The index file is initialized with a list of all paths and, for each
972 path, a blob object and a set of attributes. The blob object represents
973 the contents of the file as of the head of the current branch. The
974 attributes (last modified time, size, etc.) are taken from the
975 corresponding file in the working tree. Subsequent changes to the
976 working tree can be found by comparing these attributes. The index may
977 be updated with new content, and new commits may be created from the
978 content stored in the index.
980 The index is also capable of storing multiple entries (called "stages")
981 for a given pathname. These stages are used to hold the various
982 unmerged version of a file when a merge is in progress.
984 FURTHER DOCUMENTATION
985 ---------------------
987 See the references in the "description" section to get started
988 using Git. The following is probably more detail than necessary
989 for a first-time user.
991 The link:user-manual.html#git-concepts[Git concepts chapter of the
992 user-manual] and linkgit:gitcore-tutorial[7] both provide
993 introductions to the underlying Git architecture.
995 See linkgit:gitworkflows[7] for an overview of recommended workflows.
997 See also the link:howto-index.html[howto] documents for some useful
1000 The internals are documented in the
1001 link:technical/api-index.html[Git API documentation].
1003 Users migrating from CVS may also want to
1004 read linkgit:gitcvs-migration[7].
1009 Git was started by Linus Torvalds, and is currently maintained by Junio
1010 C Hamano. Numerous contributions have come from the Git mailing list
1011 <git@vger.kernel.org>. http://www.ohloh.net/p/git/contributors/summary
1012 gives you a more complete list of contributors.
1014 If you have a clone of git.git itself, the
1015 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
1016 the authors for specific parts of the project.
1021 Report bugs to the Git mailing list <git@vger.kernel.org> where the
1022 development and maintenance is primarily done. You do not have to be
1023 subscribed to the list to send a message there.
1027 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1028 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
1029 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1030 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1031 linkgit:gitworkflows[7]
1035 Part of the linkgit:git[1] suite