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