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