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