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