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