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