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