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