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