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