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