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