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