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