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