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