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