Git 1.8.1.3
[git/jnareb-git.git] / Documentation / git.txt
blobc7f211e81b6847ba2cc55e486c898f4405049501
1 git(1)
2 ======
4 NAME
5 ----
6 git - the stupid content tracker
9 SYNOPSIS
10 --------
11 [verse]
12 'git' [--version] [--help] [-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>]
16     <command> [<args>]
18 DESCRIPTION
19 -----------
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`.
37 ifdef::stalenotes[]
38 [NOTE]
39 ============
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.1.3/git.html[documentation for release 1.8.1.3]
48 * release notes for
49   link:RelNotes/1.8.1.3.txt[1.8.1.3],
50   link:RelNotes/1.8.1.2.txt[1.8.1.2],
51   link:RelNotes/1.8.1.1.txt[1.8.1.1],
52   link:RelNotes/1.8.1.txt[1.8.1].
54 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
56 * release notes for
57   link:RelNotes/1.8.0.3.txt[1.8.0.3],
58   link:RelNotes/1.8.0.2.txt[1.8.0.2],
59   link:RelNotes/1.8.0.1.txt[1.8.0.1],
60   link:RelNotes/1.8.0.txt[1.8.0].
62 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
64 * release notes for
65   link:RelNotes/1.7.12.4.txt[1.7.12.4],
66   link:RelNotes/1.7.12.3.txt[1.7.12.3],
67   link:RelNotes/1.7.12.2.txt[1.7.12.2],
68   link:RelNotes/1.7.12.1.txt[1.7.12.1],
69   link:RelNotes/1.7.12.txt[1.7.12].
71 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
73 * release notes for
74   link:RelNotes/1.7.11.7.txt[1.7.11.7],
75   link:RelNotes/1.7.11.6.txt[1.7.11.6],
76   link:RelNotes/1.7.11.5.txt[1.7.11.5],
77   link:RelNotes/1.7.11.4.txt[1.7.11.4],
78   link:RelNotes/1.7.11.3.txt[1.7.11.3],
79   link:RelNotes/1.7.11.2.txt[1.7.11.2],
80   link:RelNotes/1.7.11.1.txt[1.7.11.1],
81   link:RelNotes/1.7.11.txt[1.7.11].
83 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
85 * release notes for
86   link:RelNotes/1.7.10.5.txt[1.7.10.5],
87   link:RelNotes/1.7.10.4.txt[1.7.10.4],
88   link:RelNotes/1.7.10.3.txt[1.7.10.3],
89   link:RelNotes/1.7.10.2.txt[1.7.10.2],
90   link:RelNotes/1.7.10.1.txt[1.7.10.1],
91   link:RelNotes/1.7.10.txt[1.7.10].
93 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
95 * release notes for
96   link:RelNotes/1.7.9.7.txt[1.7.9.7],
97   link:RelNotes/1.7.9.6.txt[1.7.9.6],
98   link:RelNotes/1.7.9.5.txt[1.7.9.5],
99   link:RelNotes/1.7.9.4.txt[1.7.9.4],
100   link:RelNotes/1.7.9.3.txt[1.7.9.3],
101   link:RelNotes/1.7.9.2.txt[1.7.9.2],
102   link:RelNotes/1.7.9.1.txt[1.7.9.1],
103   link:RelNotes/1.7.9.txt[1.7.9].
105 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
107 * release notes for
108   link:RelNotes/1.7.8.6.txt[1.7.8.6],
109   link:RelNotes/1.7.8.5.txt[1.7.8.5],
110   link:RelNotes/1.7.8.4.txt[1.7.8.4],
111   link:RelNotes/1.7.8.3.txt[1.7.8.3],
112   link:RelNotes/1.7.8.2.txt[1.7.8.2],
113   link:RelNotes/1.7.8.1.txt[1.7.8.1],
114   link:RelNotes/1.7.8.txt[1.7.8].
116 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
118 * release notes for
119   link:RelNotes/1.7.7.7.txt[1.7.7.7],
120   link:RelNotes/1.7.7.6.txt[1.7.7.6],
121   link:RelNotes/1.7.7.5.txt[1.7.7.5],
122   link:RelNotes/1.7.7.4.txt[1.7.7.4],
123   link:RelNotes/1.7.7.3.txt[1.7.7.3],
124   link:RelNotes/1.7.7.2.txt[1.7.7.2],
125   link:RelNotes/1.7.7.1.txt[1.7.7.1],
126   link:RelNotes/1.7.7.txt[1.7.7].
128 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
130 * release notes for
131   link:RelNotes/1.7.6.6.txt[1.7.6.6],
132   link:RelNotes/1.7.6.5.txt[1.7.6.5],
133   link:RelNotes/1.7.6.4.txt[1.7.6.4],
134   link:RelNotes/1.7.6.3.txt[1.7.6.3],
135   link:RelNotes/1.7.6.2.txt[1.7.6.2],
136   link:RelNotes/1.7.6.1.txt[1.7.6.1],
137   link:RelNotes/1.7.6.txt[1.7.6].
139 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
141 * release notes for
142   link:RelNotes/1.7.5.4.txt[1.7.5.4],
143   link:RelNotes/1.7.5.3.txt[1.7.5.3],
144   link:RelNotes/1.7.5.2.txt[1.7.5.2],
145   link:RelNotes/1.7.5.1.txt[1.7.5.1],
146   link:RelNotes/1.7.5.txt[1.7.5].
148 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
150 * release notes for
151   link:RelNotes/1.7.4.5.txt[1.7.4.5],
152   link:RelNotes/1.7.4.4.txt[1.7.4.4],
153   link:RelNotes/1.7.4.3.txt[1.7.4.3],
154   link:RelNotes/1.7.4.2.txt[1.7.4.2],
155   link:RelNotes/1.7.4.1.txt[1.7.4.1],
156   link:RelNotes/1.7.4.txt[1.7.4].
158 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
160 * release notes for
161   link:RelNotes/1.7.3.5.txt[1.7.3.5],
162   link:RelNotes/1.7.3.4.txt[1.7.3.4],
163   link:RelNotes/1.7.3.3.txt[1.7.3.3],
164   link:RelNotes/1.7.3.2.txt[1.7.3.2],
165   link:RelNotes/1.7.3.1.txt[1.7.3.1],
166   link:RelNotes/1.7.3.txt[1.7.3].
168 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
170 * release notes for
171   link:RelNotes/1.7.2.5.txt[1.7.2.5],
172   link:RelNotes/1.7.2.4.txt[1.7.2.4],
173   link:RelNotes/1.7.2.3.txt[1.7.2.3],
174   link:RelNotes/1.7.2.2.txt[1.7.2.2],
175   link:RelNotes/1.7.2.1.txt[1.7.2.1],
176   link:RelNotes/1.7.2.txt[1.7.2].
178 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
180 * release notes for
181   link:RelNotes/1.7.1.4.txt[1.7.1.4],
182   link:RelNotes/1.7.1.3.txt[1.7.1.3],
183   link:RelNotes/1.7.1.2.txt[1.7.1.2],
184   link:RelNotes/1.7.1.1.txt[1.7.1.1],
185   link:RelNotes/1.7.1.txt[1.7.1].
187 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
189 * release notes for
190   link:RelNotes/1.7.0.9.txt[1.7.0.9],
191   link:RelNotes/1.7.0.8.txt[1.7.0.8],
192   link:RelNotes/1.7.0.7.txt[1.7.0.7],
193   link:RelNotes/1.7.0.6.txt[1.7.0.6],
194   link:RelNotes/1.7.0.5.txt[1.7.0.5],
195   link:RelNotes/1.7.0.4.txt[1.7.0.4],
196   link:RelNotes/1.7.0.3.txt[1.7.0.3],
197   link:RelNotes/1.7.0.2.txt[1.7.0.2],
198   link:RelNotes/1.7.0.1.txt[1.7.0.1],
199   link:RelNotes/1.7.0.txt[1.7.0].
201 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
203 * release notes for
204   link:RelNotes/1.6.6.3.txt[1.6.6.3],
205   link:RelNotes/1.6.6.2.txt[1.6.6.2],
206   link:RelNotes/1.6.6.1.txt[1.6.6.1],
207   link:RelNotes/1.6.6.txt[1.6.6].
209 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
211 * release notes for
212   link:RelNotes/1.6.5.9.txt[1.6.5.9],
213   link:RelNotes/1.6.5.8.txt[1.6.5.8],
214   link:RelNotes/1.6.5.7.txt[1.6.5.7],
215   link:RelNotes/1.6.5.6.txt[1.6.5.6],
216   link:RelNotes/1.6.5.5.txt[1.6.5.5],
217   link:RelNotes/1.6.5.4.txt[1.6.5.4],
218   link:RelNotes/1.6.5.3.txt[1.6.5.3],
219   link:RelNotes/1.6.5.2.txt[1.6.5.2],
220   link:RelNotes/1.6.5.1.txt[1.6.5.1],
221   link:RelNotes/1.6.5.txt[1.6.5].
223 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
225 * release notes for
226   link:RelNotes/1.6.4.5.txt[1.6.4.5],
227   link:RelNotes/1.6.4.4.txt[1.6.4.4],
228   link:RelNotes/1.6.4.3.txt[1.6.4.3],
229   link:RelNotes/1.6.4.2.txt[1.6.4.2],
230   link:RelNotes/1.6.4.1.txt[1.6.4.1],
231   link:RelNotes/1.6.4.txt[1.6.4].
233 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
235 * release notes for
236   link:RelNotes/1.6.3.4.txt[1.6.3.4],
237   link:RelNotes/1.6.3.3.txt[1.6.3.3],
238   link:RelNotes/1.6.3.2.txt[1.6.3.2],
239   link:RelNotes/1.6.3.1.txt[1.6.3.1],
240   link:RelNotes/1.6.3.txt[1.6.3].
242 * release notes for
243   link:RelNotes/1.6.2.5.txt[1.6.2.5],
244   link:RelNotes/1.6.2.4.txt[1.6.2.4],
245   link:RelNotes/1.6.2.3.txt[1.6.2.3],
246   link:RelNotes/1.6.2.2.txt[1.6.2.2],
247   link:RelNotes/1.6.2.1.txt[1.6.2.1],
248   link:RelNotes/1.6.2.txt[1.6.2].
250 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
252 * release notes for
253   link:RelNotes/1.6.1.3.txt[1.6.1.3],
254   link:RelNotes/1.6.1.2.txt[1.6.1.2],
255   link:RelNotes/1.6.1.1.txt[1.6.1.1],
256   link:RelNotes/1.6.1.txt[1.6.1].
258 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
260 * release notes for
261   link:RelNotes/1.6.0.6.txt[1.6.0.6],
262   link:RelNotes/1.6.0.5.txt[1.6.0.5],
263   link:RelNotes/1.6.0.4.txt[1.6.0.4],
264   link:RelNotes/1.6.0.3.txt[1.6.0.3],
265   link:RelNotes/1.6.0.2.txt[1.6.0.2],
266   link:RelNotes/1.6.0.1.txt[1.6.0.1],
267   link:RelNotes/1.6.0.txt[1.6.0].
269 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
271 * release notes for
272   link:RelNotes/1.5.6.6.txt[1.5.6.6],
273   link:RelNotes/1.5.6.5.txt[1.5.6.5],
274   link:RelNotes/1.5.6.4.txt[1.5.6.4],
275   link:RelNotes/1.5.6.3.txt[1.5.6.3],
276   link:RelNotes/1.5.6.2.txt[1.5.6.2],
277   link:RelNotes/1.5.6.1.txt[1.5.6.1],
278   link:RelNotes/1.5.6.txt[1.5.6].
280 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
282 * release notes for
283   link:RelNotes/1.5.5.6.txt[1.5.5.6],
284   link:RelNotes/1.5.5.5.txt[1.5.5.5],
285   link:RelNotes/1.5.5.4.txt[1.5.5.4],
286   link:RelNotes/1.5.5.3.txt[1.5.5.3],
287   link:RelNotes/1.5.5.2.txt[1.5.5.2],
288   link:RelNotes/1.5.5.1.txt[1.5.5.1],
289   link:RelNotes/1.5.5.txt[1.5.5].
291 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
293 * release notes for
294   link:RelNotes/1.5.4.7.txt[1.5.4.7],
295   link:RelNotes/1.5.4.6.txt[1.5.4.6],
296   link:RelNotes/1.5.4.5.txt[1.5.4.5],
297   link:RelNotes/1.5.4.4.txt[1.5.4.4],
298   link:RelNotes/1.5.4.3.txt[1.5.4.3],
299   link:RelNotes/1.5.4.2.txt[1.5.4.2],
300   link:RelNotes/1.5.4.1.txt[1.5.4.1],
301   link:RelNotes/1.5.4.txt[1.5.4].
303 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
305 * release notes for
306   link:RelNotes/1.5.3.8.txt[1.5.3.8],
307   link:RelNotes/1.5.3.7.txt[1.5.3.7],
308   link:RelNotes/1.5.3.6.txt[1.5.3.6],
309   link:RelNotes/1.5.3.5.txt[1.5.3.5],
310   link:RelNotes/1.5.3.4.txt[1.5.3.4],
311   link:RelNotes/1.5.3.3.txt[1.5.3.3],
312   link:RelNotes/1.5.3.2.txt[1.5.3.2],
313   link:RelNotes/1.5.3.1.txt[1.5.3.1],
314   link:RelNotes/1.5.3.txt[1.5.3].
316 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
318 * release notes for
319   link:RelNotes/1.5.2.5.txt[1.5.2.5],
320   link:RelNotes/1.5.2.4.txt[1.5.2.4],
321   link:RelNotes/1.5.2.3.txt[1.5.2.3],
322   link:RelNotes/1.5.2.2.txt[1.5.2.2],
323   link:RelNotes/1.5.2.1.txt[1.5.2.1],
324   link:RelNotes/1.5.2.txt[1.5.2].
326 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
328 * release notes for
329   link:RelNotes/1.5.1.6.txt[1.5.1.6],
330   link:RelNotes/1.5.1.5.txt[1.5.1.5],
331   link:RelNotes/1.5.1.4.txt[1.5.1.4],
332   link:RelNotes/1.5.1.3.txt[1.5.1.3],
333   link:RelNotes/1.5.1.2.txt[1.5.1.2],
334   link:RelNotes/1.5.1.1.txt[1.5.1.1],
335   link:RelNotes/1.5.1.txt[1.5.1].
337 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
339 * release notes for
340   link:RelNotes/1.5.0.7.txt[1.5.0.7],
341   link:RelNotes/1.5.0.6.txt[1.5.0.6],
342   link:RelNotes/1.5.0.5.txt[1.5.0.5],
343   link:RelNotes/1.5.0.3.txt[1.5.0.3],
344   link:RelNotes/1.5.0.2.txt[1.5.0.2],
345   link:RelNotes/1.5.0.1.txt[1.5.0.1],
346   link:RelNotes/1.5.0.txt[1.5.0].
348 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
349   link:v1.3.3/git.html[1.3.3],
350   link:v1.2.6/git.html[1.2.6],
351   link:v1.0.13/git.html[1.0.13].
353 ============
355 endif::stalenotes[]
357 OPTIONS
358 -------
359 --version::
360         Prints the git suite version that the 'git' program came from.
362 --help::
363         Prints the synopsis and a list of the most commonly used
364         commands. If the option '--all' or '-a' is given then all
365         available commands are printed. If a git command is named this
366         option will bring up the manual page for that command.
368 Other options are available to control how the manual page is
369 displayed. See linkgit:git-help[1] for more information,
370 because `git --help ...` is converted internally into `git
371 help ...`.
373 -c <name>=<value>::
374         Pass a configuration parameter to the command. The value
375         given will override values from configuration files.
376         The <name> is expected in the same format as listed by
377         'git config' (subkeys separated by dots).
379 --exec-path[=<path>]::
380         Path to wherever your core git programs are installed.
381         This can also be controlled by setting the GIT_EXEC_PATH
382         environment variable. If no path is given, 'git' will print
383         the current setting and then exit.
385 --html-path::
386         Print the path, without trailing slash, where git's HTML
387         documentation is installed and exit.
389 --man-path::
390         Print the manpath (see `man(1)`) for the man pages for
391         this version of git and exit.
393 --info-path::
394         Print the path where the Info files documenting this
395         version of git are installed and exit.
397 -p::
398 --paginate::
399         Pipe all output into 'less' (or if set, $PAGER) if standard
400         output is a terminal.  This overrides the `pager.<cmd>`
401         configuration options (see the "Configuration Mechanism" section
402         below).
404 --no-pager::
405         Do not pipe git output into a pager.
407 --git-dir=<path>::
408         Set the path to the repository. This can also be controlled by
409         setting the GIT_DIR environment variable. It can be an absolute
410         path or relative path to current working directory.
412 --work-tree=<path>::
413         Set the path to the working tree. It can be an absolute path
414         or a path relative to the current working directory.
415         This can also be controlled by setting the GIT_WORK_TREE
416         environment variable and the core.worktree configuration
417         variable (see core.worktree in linkgit:git-config[1] for a
418         more detailed discussion).
420 --namespace=<path>::
421         Set the git namespace.  See linkgit:gitnamespaces[7] for more
422         details.  Equivalent to setting the `GIT_NAMESPACE` environment
423         variable.
425 --bare::
426         Treat the repository as a bare repository.  If GIT_DIR
427         environment is not set, it is set to the current working
428         directory.
430 --no-replace-objects::
431         Do not use replacement refs to replace git objects. See
432         linkgit:git-replace[1] for more information.
435 GIT COMMANDS
436 ------------
438 We divide git into high level ("porcelain") commands and low level
439 ("plumbing") commands.
441 High-level commands (porcelain)
442 -------------------------------
444 We separate the porcelain commands into the main commands and some
445 ancillary user utilities.
447 Main porcelain commands
448 ~~~~~~~~~~~~~~~~~~~~~~~
450 include::cmds-mainporcelain.txt[]
452 Ancillary Commands
453 ~~~~~~~~~~~~~~~~~~
454 Manipulators:
456 include::cmds-ancillarymanipulators.txt[]
458 Interrogators:
460 include::cmds-ancillaryinterrogators.txt[]
463 Interacting with Others
464 ~~~~~~~~~~~~~~~~~~~~~~~
466 These commands are to interact with foreign SCM and with other
467 people via patch over e-mail.
469 include::cmds-foreignscminterface.txt[]
472 Low-level commands (plumbing)
473 -----------------------------
475 Although git includes its
476 own porcelain layer, its low-level commands are sufficient to support
477 development of alternative porcelains.  Developers of such porcelains
478 might start by reading about linkgit:git-update-index[1] and
479 linkgit:git-read-tree[1].
481 The interface (input, output, set of options and the semantics)
482 to these low-level commands are meant to be a lot more stable
483 than Porcelain level commands, because these commands are
484 primarily for scripted use.  The interface to Porcelain commands
485 on the other hand are subject to change in order to improve the
486 end user experience.
488 The following description divides
489 the low-level commands into commands that manipulate objects (in
490 the repository, index, and working tree), commands that interrogate and
491 compare objects, and commands that move objects and references between
492 repositories.
495 Manipulation commands
496 ~~~~~~~~~~~~~~~~~~~~~
498 include::cmds-plumbingmanipulators.txt[]
501 Interrogation commands
502 ~~~~~~~~~~~~~~~~~~~~~~
504 include::cmds-plumbinginterrogators.txt[]
506 In general, the interrogate commands do not touch the files in
507 the working tree.
510 Synching repositories
511 ~~~~~~~~~~~~~~~~~~~~~
513 include::cmds-synchingrepositories.txt[]
515 The following are helper commands used by the above; end users
516 typically do not use them directly.
518 include::cmds-synchelpers.txt[]
521 Internal helper commands
522 ~~~~~~~~~~~~~~~~~~~~~~~~
524 These are internal helper commands used by other commands; end
525 users typically do not use them directly.
527 include::cmds-purehelpers.txt[]
530 Configuration Mechanism
531 -----------------------
533 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
534 is used to hold per-repository configuration options.  It is a
535 simple text file modeled after `.ini` format familiar to some
536 people.  Here is an example:
538 ------------
540 # A '#' or ';' character indicates a comment.
543 ; core variables
544 [core]
545         ; Don't trust file modes
546         filemode = false
548 ; user identity
549 [user]
550         name = "Junio C Hamano"
551         email = "junkio@twinsun.com"
553 ------------
555 Various commands read from the configuration file and adjust
556 their operation accordingly.  See linkgit:git-config[1] for a
557 list.
560 Identifier Terminology
561 ----------------------
562 <object>::
563         Indicates the object name for any type of object.
565 <blob>::
566         Indicates a blob object name.
568 <tree>::
569         Indicates a tree object name.
571 <commit>::
572         Indicates a commit object name.
574 <tree-ish>::
575         Indicates a tree, commit or tag object name.  A
576         command that takes a <tree-ish> argument ultimately wants to
577         operate on a <tree> object but automatically dereferences
578         <commit> and <tag> objects that point at a <tree>.
580 <commit-ish>::
581         Indicates a commit or tag object name.  A
582         command that takes a <commit-ish> argument ultimately wants to
583         operate on a <commit> object but automatically dereferences
584         <tag> objects that point at a <commit>.
586 <type>::
587         Indicates that an object type is required.
588         Currently one of: `blob`, `tree`, `commit`, or `tag`.
590 <file>::
591         Indicates a filename - almost always relative to the
592         root of the tree structure `GIT_INDEX_FILE` describes.
594 Symbolic Identifiers
595 --------------------
596 Any git command accepting any <object> can also use the following
597 symbolic notation:
599 HEAD::
600         indicates the head of the current branch.
602 <tag>::
603         a valid tag 'name'
604         (i.e. a `refs/tags/<tag>` reference).
606 <head>::
607         a valid head 'name'
608         (i.e. a `refs/heads/<head>` reference).
610 For a more complete list of ways to spell object names, see
611 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
614 File/Directory Structure
615 ------------------------
617 Please see the linkgit:gitrepository-layout[5] document.
619 Read linkgit:githooks[5] for more details about each hook.
621 Higher level SCMs may provide and manage additional information in the
622 `$GIT_DIR`.
625 Terminology
626 -----------
627 Please see linkgit:gitglossary[7].
630 Environment Variables
631 ---------------------
632 Various git commands use the following environment variables:
634 The git Repository
635 ~~~~~~~~~~~~~~~~~~
636 These environment variables apply to 'all' core git commands. Nb: it
637 is worth noting that they may be used/overridden by SCMS sitting above
638 git so take care if using Cogito etc.
640 'GIT_INDEX_FILE'::
641         This environment allows the specification of an alternate
642         index file. If not specified, the default of `$GIT_DIR/index`
643         is used.
645 'GIT_OBJECT_DIRECTORY'::
646         If the object storage directory is specified via this
647         environment variable then the sha1 directories are created
648         underneath - otherwise the default `$GIT_DIR/objects`
649         directory is used.
651 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
652         Due to the immutable nature of git objects, old objects can be
653         archived into shared, read-only directories. This variable
654         specifies a ":" separated (on Windows ";" separated) list
655         of git object directories which can be used to search for git
656         objects. New objects will not be written to these directories.
658 'GIT_DIR'::
659         If the 'GIT_DIR' environment variable is set then it
660         specifies a path to use instead of the default `.git`
661         for the base of the repository.
662         The '--git-dir' command-line option also sets this value.
664 'GIT_WORK_TREE'::
665         Set the path to the working tree.  The value will not be
666         used in combination with repositories found automatically in
667         a .git directory (i.e. $GIT_DIR is not set).
668         This can also be controlled by the '--work-tree' command line
669         option and the core.worktree configuration variable.
671 'GIT_NAMESPACE'::
672         Set the git namespace; see linkgit:gitnamespaces[7] for details.
673         The '--namespace' command-line option also sets this value.
675 'GIT_CEILING_DIRECTORIES'::
676         This should be a colon-separated list of absolute paths.
677         If set, it is a list of directories that git should not chdir
678         up into while looking for a repository directory.
679         It will not exclude the current working directory or
680         a GIT_DIR set on the command line or in the environment.
681         (Useful for excluding slow-loading network directories.)
683 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
684         When run in a directory that does not have ".git" repository
685         directory, git tries to find such a directory in the parent
686         directories to find the top of the working tree, but by default it
687         does not cross filesystem boundaries.  This environment variable
688         can be set to true to tell git not to stop at filesystem
689         boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
690         an explicit repository directory set via 'GIT_DIR' or on the
691         command line.
693 git Commits
694 ~~~~~~~~~~~
695 'GIT_AUTHOR_NAME'::
696 'GIT_AUTHOR_EMAIL'::
697 'GIT_AUTHOR_DATE'::
698 'GIT_COMMITTER_NAME'::
699 'GIT_COMMITTER_EMAIL'::
700 'GIT_COMMITTER_DATE'::
701 'EMAIL'::
702         see linkgit:git-commit-tree[1]
704 git Diffs
705 ~~~~~~~~~
706 'GIT_DIFF_OPTS'::
707         Only valid setting is "--unified=??" or "-u??" to set the
708         number of context lines shown when a unified diff is created.
709         This takes precedence over any "-U" or "--unified" option
710         value passed on the git diff command line.
712 'GIT_EXTERNAL_DIFF'::
713         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
714         program named by it is called, instead of the diff invocation
715         described above.  For a path that is added, removed, or modified,
716         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
718         path old-file old-hex old-mode new-file new-hex new-mode
720 where:
722         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
723                          contents of <old|new>,
724         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
725         <old|new>-mode:: are the octal representation of the file modes.
727 The file parameters can point at the user's working file
728 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
729 when a new file is added), or a temporary file (e.g. `old-file` in the
730 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
731 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
733 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
734 parameter, <path>.
736 other
737 ~~~~~
738 'GIT_MERGE_VERBOSITY'::
739         A number controlling the amount of output shown by
740         the recursive merge strategy.  Overrides merge.verbosity.
741         See linkgit:git-merge[1]
743 'GIT_PAGER'::
744         This environment variable overrides `$PAGER`. If it is set
745         to an empty string or to the value "cat", git will not launch
746         a pager.  See also the `core.pager` option in
747         linkgit:git-config[1].
749 'GIT_EDITOR'::
750         This environment variable overrides `$EDITOR` and `$VISUAL`.
751         It is used by several git commands when, on interactive mode,
752         an editor is to be launched. See also linkgit:git-var[1]
753         and the `core.editor` option in linkgit:git-config[1].
755 'GIT_SSH'::
756         If this environment variable is set then 'git fetch'
757         and 'git push' will use this command instead
758         of 'ssh' when they need to connect to a remote system.
759         The '$GIT_SSH' command will be given exactly two arguments:
760         the 'username@host' (or just 'host') from the URL and the
761         shell command to execute on that remote system.
763 To pass options to the program that you want to list in GIT_SSH
764 you will need to wrap the program and options into a shell script,
765 then set GIT_SSH to refer to the shell script.
767 Usually it is easier to configure any desired options through your
768 personal `.ssh/config` file.  Please consult your ssh documentation
769 for further details.
771 'GIT_ASKPASS'::
772         If this environment variable is set, then git commands which need to
773         acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
774         will call this program with a suitable prompt as command line argument
775         and read the password from its STDOUT. See also the 'core.askpass'
776         option in linkgit:git-config[1].
778 'GIT_CONFIG_NOSYSTEM'::
779         Whether to skip reading settings from the system-wide
780         `$(prefix)/etc/gitconfig` file.  This environment variable can
781         be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
782         predictable environment for a picky script, or you can set it
783         temporarily to avoid using a buggy `/etc/gitconfig` file while
784         waiting for someone with sufficient permissions to fix it.
786 'GIT_FLUSH'::
787         If this environment variable is set to "1", then commands such
788         as 'git blame' (in incremental mode), 'git rev-list', 'git log',
789         and 'git whatchanged' will force a flush of the output stream
790         after each commit-oriented record have been flushed.   If this
791         variable is set to "0", the output of these commands will be done
792         using completely buffered I/O.   If this environment variable is
793         not set, git will choose buffered or record-oriented flushing
794         based on whether stdout appears to be redirected to a file or not.
796 'GIT_TRACE'::
797         If this variable is set to "1", "2" or "true" (comparison
798         is case insensitive), git will print `trace:` messages on
799         stderr telling about alias expansion, built-in command
800         execution and external command execution.
801         If this variable is set to an integer value greater than 1
802         and lower than 10 (strictly) then git will interpret this
803         value as an open file descriptor and will try to write the
804         trace messages into this file descriptor.
805         Alternatively, if this variable is set to an absolute path
806         (starting with a '/' character), git will interpret this
807         as a file path and will try to write the trace messages
808         into it.
810 Discussion[[Discussion]]
811 ------------------------
813 More detail on the following is available from the
814 link:user-manual.html#git-concepts[git concepts chapter of the
815 user-manual] and linkgit:gitcore-tutorial[7].
817 A git project normally consists of a working directory with a ".git"
818 subdirectory at the top level.  The .git directory contains, among other
819 things, a compressed object database representing the complete history
820 of the project, an "index" file which links that history to the current
821 contents of the working tree, and named pointers into that history such
822 as tags and branch heads.
824 The object database contains objects of three main types: blobs, which
825 hold file data; trees, which point to blobs and other trees to build up
826 directory hierarchies; and commits, which each reference a single tree
827 and some number of parent commits.
829 The commit, equivalent to what other systems call a "changeset" or
830 "version", represents a step in the project's history, and each parent
831 represents an immediately preceding step.  Commits with more than one
832 parent represent merges of independent lines of development.
834 All objects are named by the SHA1 hash of their contents, normally
835 written as a string of 40 hex digits.  Such names are globally unique.
836 The entire history leading up to a commit can be vouched for by signing
837 just that commit.  A fourth object type, the tag, is provided for this
838 purpose.
840 When first created, objects are stored in individual files, but for
841 efficiency may later be compressed together into "pack files".
843 Named pointers called refs mark interesting points in history.  A ref
844 may contain the SHA1 name of an object or the name of another ref.  Refs
845 with names beginning `ref/head/` contain the SHA1 name of the most
846 recent commit (or "head") of a branch under development.  SHA1 names of
847 tags of interest are stored under `ref/tags/`.  A special ref named
848 `HEAD` contains the name of the currently checked-out branch.
850 The index file is initialized with a list of all paths and, for each
851 path, a blob object and a set of attributes.  The blob object represents
852 the contents of the file as of the head of the current branch.  The
853 attributes (last modified time, size, etc.) are taken from the
854 corresponding file in the working tree.  Subsequent changes to the
855 working tree can be found by comparing these attributes.  The index may
856 be updated with new content, and new commits may be created from the
857 content stored in the index.
859 The index is also capable of storing multiple entries (called "stages")
860 for a given pathname.  These stages are used to hold the various
861 unmerged version of a file when a merge is in progress.
863 FURTHER DOCUMENTATION
864 ---------------------
866 See the references in the "description" section to get started
867 using git.  The following is probably more detail than necessary
868 for a first-time user.
870 The link:user-manual.html#git-concepts[git concepts chapter of the
871 user-manual] and linkgit:gitcore-tutorial[7] both provide
872 introductions to the underlying git architecture.
874 See linkgit:gitworkflows[7] for an overview of recommended workflows.
876 See also the link:howto-index.html[howto] documents for some useful
877 examples.
879 The internals are documented in the
880 link:technical/api-index.html[GIT API documentation].
882 Users migrating from CVS may also want to
883 read linkgit:gitcvs-migration[7].
886 Authors
887 -------
888 Git was started by Linus Torvalds, and is currently maintained by Junio
889 C Hamano. Numerous contributions have come from the git mailing list
890 <git@vger.kernel.org>.  http://www.ohloh.net/p/git/contributors/summary
891 gives you a more complete list of contributors.
893 If you have a clone of git.git itself, the
894 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
895 the authors for specific parts of the project.
897 Reporting Bugs
898 --------------
900 Report bugs to the Git mailing list <git@vger.kernel.org> where the
901 development and maintenance is primarily done.  You do not have to be
902 subscribed to the list to send a message there.
904 SEE ALSO
905 --------
906 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
907 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
908 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
909 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
910 linkgit:gitworkflows[7]
914 Part of the linkgit:git[1] suite