Documentation/git.txt

   1 git(1)
   2 ======
   3
   4 NAME
   5 ----
   6 git - the stupid content tracker
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git' [--version] [--exec-path[=GIT_EXEC_PATH]]
  13     [-p|--paginate|--no-pager]
  14     [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
  15     [--help] COMMAND [ARGS]
  16
  17 DESCRIPTION
  18 -----------
  19 Git is a fast, scalable, distributed revision control system with an
  20 unusually rich command set that provides both high-level operations
  21 and full access to internals.
  22
  23 See linkgit:gittutorial[7] to get started, then see
  24 link:everyday.html[Everyday Git] for a useful minimum set of commands, and
  25 "man git-commandname" for documentation of each command.  CVS users may
  26 also want to read linkgit:gitcvs-migration[7].  See
  27 the link:user-manual.html[Git User's Manual] for a more in-depth
  28 introduction.
  29
  30 The COMMAND is either a name of a Git command (see below) or an alias
  31 as defined in the configuration file (see linkgit:git-config[1]).
  32
  33 Formatted and hyperlinked version of the latest git
  34 documentation can be viewed at
  35 `http://www.kernel.org/pub/software/scm/git/docs/`.
  36
  37 ifdef::stalenotes[]
  38 [NOTE]
  39 ============
  40
  41 You are reading the documentation for the latest (possibly
  42 unreleased) version of git, that is available from 'master'
  43 branch of the `git.git` repository.
  44 Documentation for older releases are available here:
  45
  46 * link:v1.5.6.5/git.html[documentation for release 1.5.6.5]
  47
  48 * release notes for
  49   link:RelNotes-1.5.6.5.txt[1.5.6.5],
  50   link:RelNotes-1.5.6.4.txt[1.5.6.4],
  51   link:RelNotes-1.5.6.3.txt[1.5.6.3],
  52   link:RelNotes-1.5.6.2.txt[1.5.6.2],
  53   link:RelNotes-1.5.6.1.txt[1.5.6.1],
  54   link:RelNotes-1.5.6.txt[1.5.6].
  55
  56 * link:v1.5.5.4/git.html[documentation for release 1.5.5.4]
  57
  58 * release notes for
  59   link:RelNotes-1.5.5.4.txt[1.5.5.4],
  60   link:RelNotes-1.5.5.3.txt[1.5.5.3],
  61   link:RelNotes-1.5.5.2.txt[1.5.5.2],
  62   link:RelNotes-1.5.5.1.txt[1.5.5.1],
  63   link:RelNotes-1.5.5.txt[1.5.5].
  64
  65 * link:v1.5.4.5/git.html[documentation for release 1.5.4.5]
  66
  67 * release notes for
  68   link:RelNotes-1.5.4.5.txt[1.5.4.5],
  69   link:RelNotes-1.5.4.4.txt[1.5.4.4],
  70   link:RelNotes-1.5.4.3.txt[1.5.4.3],
  71   link:RelNotes-1.5.4.2.txt[1.5.4.2],
  72   link:RelNotes-1.5.4.1.txt[1.5.4.1],
  73   link:RelNotes-1.5.4.txt[1.5.4].
  74
  75 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
  76
  77 * release notes for
  78   link:RelNotes-1.5.3.8.txt[1.5.3.8],
  79   link:RelNotes-1.5.3.7.txt[1.5.3.7],
  80   link:RelNotes-1.5.3.6.txt[1.5.3.6],
  81   link:RelNotes-1.5.3.5.txt[1.5.3.5],
  82   link:RelNotes-1.5.3.4.txt[1.5.3.4],
  83   link:RelNotes-1.5.3.3.txt[1.5.3.3],
  84   link:RelNotes-1.5.3.2.txt[1.5.3.2],
  85   link:RelNotes-1.5.3.1.txt[1.5.3.1],
  86   link:RelNotes-1.5.3.txt[1.5.3].
  87
  88 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
  89
  90 * release notes for
  91   link:RelNotes-1.5.2.5.txt[1.5.2.5],
  92   link:RelNotes-1.5.2.4.txt[1.5.2.4],
  93   link:RelNotes-1.5.2.3.txt[1.5.2.3],
  94   link:RelNotes-1.5.2.2.txt[1.5.2.2],
  95   link:RelNotes-1.5.2.1.txt[1.5.2.1],
  96   link:RelNotes-1.5.2.txt[1.5.2].
  97
  98 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
  99
 100 * release notes for
 101   link:RelNotes-1.5.1.6.txt[1.5.1.6],
 102   link:RelNotes-1.5.1.5.txt[1.5.1.5],
 103   link:RelNotes-1.5.1.4.txt[1.5.1.4],
 104   link:RelNotes-1.5.1.3.txt[1.5.1.3],
 105   link:RelNotes-1.5.1.2.txt[1.5.1.2],
 106   link:RelNotes-1.5.1.1.txt[1.5.1.1],
 107   link:RelNotes-1.5.1.txt[1.5.1].
 108
 109 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
 110
 111 * release notes for
 112   link:RelNotes-1.5.0.7.txt[1.5.0.7],
 113   link:RelNotes-1.5.0.6.txt[1.5.0.6],
 114   link:RelNotes-1.5.0.5.txt[1.5.0.5],
 115   link:RelNotes-1.5.0.3.txt[1.5.0.3],
 116   link:RelNotes-1.5.0.2.txt[1.5.0.2],
 117   link:RelNotes-1.5.0.1.txt[1.5.0.1],
 118   link:RelNotes-1.5.0.txt[1.5.0].
 119
 120 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
 121   link:v1.3.3/git.html[1.3.3],
 122   link:v1.2.6/git.html[1.2.6],
 123   link:v1.0.13/git.html[1.0.13].
 124
 125 ============
 126
 127 endif::stalenotes[]
 128
 129 OPTIONS
 130 -------
 131 --version::
 132         Prints the git suite version that the 'git' program came from.
 133
 134 --help::
 135         Prints the synopsis and a list of the most commonly used
 136         commands. If the option '--all' or '-a' is given then all
 137         available commands are printed. If a git command is named this
 138         option will bring up the manual page for that command.
 139 +
 140 Other options are available to control how the manual page is
 141 displayed. See linkgit:git-help[1] for more information,
 142 because `git --help ...` is converted internally into `git
 143 help ...`.
 144
 145 --exec-path::
 146         Path to wherever your core git programs are installed.
 147         This can also be controlled by setting the GIT_EXEC_PATH
 148         environment variable. If no path is given, 'git' will print
 149         the current setting and then exit.
 150
 151 -p::
 152 --paginate::
 153         Pipe all output into 'less' (or if set, $PAGER).
 154
 155 --no-pager::
 156         Do not pipe git output into a pager.
 157
 158 --git-dir=<path>::
 159         Set the path to the repository. This can also be controlled by
 160         setting the GIT_DIR environment variable. It can be an absolute
 161         path or relative path to current working directory.
 162
 163 --work-tree=<path>::
 164         Set the path to the working tree.  The value will not be
 165         used in combination with repositories found automatically in
 166         a .git directory (i.e. $GIT_DIR is not set).
 167         This can also be controlled by setting the GIT_WORK_TREE
 168         environment variable and the core.worktree configuration
 169         variable. It can be an absolute path or relative path to
 170         the directory specified by --git-dir or GIT_DIR.
 171         Note: If --git-dir or GIT_DIR are specified but none of
 172         --work-tree, GIT_WORK_TREE and core.worktree is specified,
 173         the current working directory is regarded as the top directory
 174         of your working tree.
 175
 176 --bare::
 177         Treat the repository as a bare repository.  If GIT_DIR
 178         environment is not set, it is set to the current working
 179         directory.
 180
 181
 182 FURTHER DOCUMENTATION
 183 ---------------------
 184
 185 See the references above to get started using git.  The following is
 186 probably more detail than necessary for a first-time user.
 187
 188 The link:user-manual.html#git-concepts[git concepts chapter of the
 189 user-manual] and linkgit:gitcore-tutorial[7] both provide
 190 introductions to the underlying git architecture.
 191
 192 See also the link:howto-index.html[howto] documents for some useful
 193 examples.
 194
 195 The internals are documented in the
 196 link:technical/api-index.html[GIT API documentation].
 197
 198 GIT COMMANDS
 199 ------------
 200
 201 We divide git into high level ("porcelain") commands and low level
 202 ("plumbing") commands.
 203
 204 High-level commands (porcelain)
 205 -------------------------------
 206
 207 We separate the porcelain commands into the main commands and some
 208 ancillary user utilities.
 209
 210 Main porcelain commands
 211 ~~~~~~~~~~~~~~~~~~~~~~~
 212
 213 include::cmds-mainporcelain.txt[]
 214
 215 Ancillary Commands
 216 ~~~~~~~~~~~~~~~~~~
 217 Manipulators:
 218
 219 include::cmds-ancillarymanipulators.txt[]
 220
 221 Interrogators:
 222
 223 include::cmds-ancillaryinterrogators.txt[]
 224
 225
 226 Interacting with Others
 227 ~~~~~~~~~~~~~~~~~~~~~~~
 228
 229 These commands are to interact with foreign SCM and with other
 230 people via patch over e-mail.
 231
 232 include::cmds-foreignscminterface.txt[]
 233
 234
 235 Low-level commands (plumbing)
 236 -----------------------------
 237
 238 Although git includes its
 239 own porcelain layer, its low-level commands are sufficient to support
 240 development of alternative porcelains.  Developers of such porcelains
 241 might start by reading about linkgit:git-update-index[1] and
 242 linkgit:git-read-tree[1].
 243
 244 The interface (input, output, set of options and the semantics)
 245 to these low-level commands are meant to be a lot more stable
 246 than Porcelain level commands, because these commands are
 247 primarily for scripted use.  The interface to Porcelain commands
 248 on the other hand are subject to change in order to improve the
 249 end user experience.
 250
 251 The following description divides
 252 the low-level commands into commands that manipulate objects (in
 253 the repository, index, and working tree), commands that interrogate and
 254 compare objects, and commands that move objects and references between
 255 repositories.
 256
 257
 258 Manipulation commands
 259 ~~~~~~~~~~~~~~~~~~~~~
 260
 261 include::cmds-plumbingmanipulators.txt[]
 262
 263
 264 Interrogation commands
 265 ~~~~~~~~~~~~~~~~~~~~~~
 266
 267 include::cmds-plumbinginterrogators.txt[]
 268
 269 In general, the interrogate commands do not touch the files in
 270 the working tree.
 271
 272
 273 Synching repositories
 274 ~~~~~~~~~~~~~~~~~~~~~
 275
 276 include::cmds-synchingrepositories.txt[]
 277
 278 The following are helper programs used by the above; end users
 279 typically do not use them directly.
 280
 281 include::cmds-synchelpers.txt[]
 282
 283
 284 Internal helper commands
 285 ~~~~~~~~~~~~~~~~~~~~~~~~
 286
 287 These are internal helper commands used by other commands; end
 288 users typically do not use them directly.
 289
 290 include::cmds-purehelpers.txt[]
 291
 292
 293 Configuration Mechanism
 294 -----------------------
 295
 296 Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
 297 is used to hold per-repository configuration options.  It is a
 298 simple text file modeled after `.ini` format familiar to some
 299 people.  Here is an example:
 300
 301 ------------
 302 #
 303 # A '#' or ';' character indicates a comment.
 304 #
 305
 306 ; core variables
 307 [core]
 308         ; Don't trust file modes
 309         filemode = false
 310
 311 ; user identity
 312 [user]
 313         name = "Junio C Hamano"
 314         email = "junkio@twinsun.com"
 315
 316 ------------
 317
 318 Various commands read from the configuration file and adjust
 319 their operation accordingly.
 320
 321
 322 Identifier Terminology
 323 ----------------------
 324 <object>::
 325         Indicates the object name for any type of object.
 326
 327 <blob>::
 328         Indicates a blob object name.
 329
 330 <tree>::
 331         Indicates a tree object name.
 332
 333 <commit>::
 334         Indicates a commit object name.
 335
 336 <tree-ish>::
 337         Indicates a tree, commit or tag object name.  A
 338         command that takes a <tree-ish> argument ultimately wants to
 339         operate on a <tree> object but automatically dereferences
 340         <commit> and <tag> objects that point at a <tree>.
 341
 342 <commit-ish>::
 343         Indicates a commit or tag object name.  A
 344         command that takes a <commit-ish> argument ultimately wants to
 345         operate on a <commit> object but automatically dereferences
 346         <tag> objects that point at a <commit>.
 347
 348 <type>::
 349         Indicates that an object type is required.
 350         Currently one of: `blob`, `tree`, `commit`, or `tag`.
 351
 352 <file>::
 353         Indicates a filename - almost always relative to the
 354         root of the tree structure `GIT_INDEX_FILE` describes.
 355
 356 Symbolic Identifiers
 357 --------------------
 358 Any git command accepting any <object> can also use the following
 359 symbolic notation:
 360
 361 HEAD::
 362         indicates the head of the current branch (i.e. the
 363         contents of `$GIT_DIR/HEAD`).
 364
 365 <tag>::
 366         a valid tag 'name'
 367         (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
 368
 369 <head>::
 370         a valid head 'name'
 371         (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
 372
 373 For a more complete list of ways to spell object names, see
 374 "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
 375
 376
 377 File/Directory Structure
 378 ------------------------
 379
 380 Please see the linkgit:gitrepository-layout[5] document.
 381
 382 Read linkgit:githooks[5] for more details about each hook.
 383
 384 Higher level SCMs may provide and manage additional information in the
 385 `$GIT_DIR`.
 386
 387
 388 Terminology
 389 -----------
 390 Please see linkgit:gitglossary[7].
 391
 392
 393 Environment Variables
 394 ---------------------
 395 Various git commands use the following environment variables:
 396
 397 The git Repository
 398 ~~~~~~~~~~~~~~~~~~
 399 These environment variables apply to 'all' core git commands. Nb: it
 400 is worth noting that they may be used/overridden by SCMS sitting above
 401 git so take care if using Cogito etc.
 402
 403 'GIT_INDEX_FILE'::
 404         This environment allows the specification of an alternate
 405         index file. If not specified, the default of `$GIT_DIR/index`
 406         is used.
 407
 408 'GIT_OBJECT_DIRECTORY'::
 409         If the object storage directory is specified via this
 410         environment variable then the sha1 directories are created
 411         underneath - otherwise the default `$GIT_DIR/objects`
 412         directory is used.
 413
 414 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
 415         Due to the immutable nature of git objects, old objects can be
 416         archived into shared, read-only directories. This variable
 417         specifies a ":" separated (on Windows ";" separated) list
 418         of git object directories which can be used to search for git
 419         objects. New objects will not be written to these directories.
 420
 421 'GIT_DIR'::
 422         If the 'GIT_DIR' environment variable is set then it
 423         specifies a path to use instead of the default `.git`
 424         for the base of the repository.
 425
 426 'GIT_WORK_TREE'::
 427         Set the path to the working tree.  The value will not be
 428         used in combination with repositories found automatically in
 429         a .git directory (i.e. $GIT_DIR is not set).
 430         This can also be controlled by the '--work-tree' command line
 431         option and the core.worktree configuration variable.
 432
 433 'GIT_CEILING_DIRECTORIES'::
 434         This should be a colon-separated list of absolute paths.
 435         If set, it is a list of directories that git should not chdir
 436         up into while looking for a repository directory.
 437         It will not exclude the current working directory or
 438         a GIT_DIR set on the command line or in the environment.
 439         (Useful for excluding slow-loading network directories.)
 440
 441 git Commits
 442 ~~~~~~~~~~~
 443 'GIT_AUTHOR_NAME'::
 444 'GIT_AUTHOR_EMAIL'::
 445 'GIT_AUTHOR_DATE'::
 446 'GIT_COMMITTER_NAME'::
 447 'GIT_COMMITTER_EMAIL'::
 448 'GIT_COMMITTER_DATE'::
 449 'EMAIL'::
 450         see linkgit:git-commit-tree[1]
 451
 452 git Diffs
 453 ~~~~~~~~~
 454 'GIT_DIFF_OPTS'::
 455         Only valid setting is "--unified=??" or "-u??" to set the
 456         number of context lines shown when a unified diff is created.
 457         This takes precedence over any "-U" or "--unified" option
 458         value passed on the git diff command line.
 459
 460 'GIT_EXTERNAL_DIFF'::
 461         When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
 462         program named by it is called, instead of the diff invocation
 463         described above.  For a path that is added, removed, or modified,
 464         'GIT_EXTERNAL_DIFF' is called with 7 parameters:
 465
 466         path old-file old-hex old-mode new-file new-hex new-mode
 467 +
 468 where:
 469
 470         <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
 471                          contents of <old|new>,
 472         <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
 473         <old|new>-mode:: are the octal representation of the file modes.
 474
 475 +
 476 The file parameters can point at the user's working file
 477 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
 478 when a new file is added), or a temporary file (e.g. `old-file` in the
 479 index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
 480 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
 481 +
 482 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
 483 parameter, <path>.
 484
 485 other
 486 ~~~~~
 487 'GIT_MERGE_VERBOSITY'::
 488         A number controlling the amount of output shown by
 489         the recursive merge strategy.  Overrides merge.verbosity.
 490         See linkgit:git-merge[1]
 491
 492 'GIT_PAGER'::
 493         This environment variable overrides `$PAGER`. If it is set
 494         to an empty string or to the value "cat", git will not launch
 495         a pager.
 496
 497 'GIT_SSH'::
 498         If this environment variable is set then 'git-fetch'
 499         and 'git-push' will use this command instead
 500         of 'ssh' when they need to connect to a remote system.
 501         The '$GIT_SSH' command will be given exactly two arguments:
 502         the 'username@host' (or just 'host') from the URL and the
 503         shell command to execute on that remote system.
 504 +
 505 To pass options to the program that you want to list in GIT_SSH
 506 you will need to wrap the program and options into a shell script,
 507 then set GIT_SSH to refer to the shell script.
 508 +
 509 Usually it is easier to configure any desired options through your
 510 personal `.ssh/config` file.  Please consult your ssh documentation
 511 for further details.
 512
 513 'GIT_FLUSH'::
 514         If this environment variable is set to "1", then commands such
 515         as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log',
 516         and 'git-whatchanged' will force a flush of the output stream
 517         after each commit-oriented record have been flushed.   If this
 518         variable is set to "0", the output of these commands will be done
 519         using completely buffered I/O.   If this environment variable is
 520         not set, git will choose buffered or record-oriented flushing
 521         based on whether stdout appears to be redirected to a file or not.
 522
 523 'GIT_TRACE'::
 524         If this variable is set to "1", "2" or "true" (comparison
 525         is case insensitive), git will print `trace:` messages on
 526         stderr telling about alias expansion, built-in command
 527         execution and external command execution.
 528         If this variable is set to an integer value greater than 1
 529         and lower than 10 (strictly) then git will interpret this
 530         value as an open file descriptor and will try to write the
 531         trace messages into this file descriptor.
 532         Alternatively, if this variable is set to an absolute path
 533         (starting with a '/' character), git will interpret this
 534         as a file path and will try to write the trace messages
 535         into it.
 536
 537 Discussion[[Discussion]]
 538 ------------------------
 539
 540 More detail on the following is available from the
 541 link:user-manual.html#git-concepts[git concepts chapter of the
 542 user-manual] and linkgit:gitcore-tutorial[7].
 543
 544 A git project normally consists of a working directory with a ".git"
 545 subdirectory at the top level.  The .git directory contains, among other
 546 things, a compressed object database representing the complete history
 547 of the project, an "index" file which links that history to the current
 548 contents of the working tree, and named pointers into that history such
 549 as tags and branch heads.
 550
 551 The object database contains objects of three main types: blobs, which
 552 hold file data; trees, which point to blobs and other trees to build up
 553 directory hierarchies; and commits, which each reference a single tree
 554 and some number of parent commits.
 555
 556 The commit, equivalent to what other systems call a "changeset" or
 557 "version", represents a step in the project's history, and each parent
 558 represents an immediately preceding step.  Commits with more than one
 559 parent represent merges of independent lines of development.
 560
 561 All objects are named by the SHA1 hash of their contents, normally
 562 written as a string of 40 hex digits.  Such names are globally unique.
 563 The entire history leading up to a commit can be vouched for by signing
 564 just that commit.  A fourth object type, the tag, is provided for this
 565 purpose.
 566
 567 When first created, objects are stored in individual files, but for
 568 efficiency may later be compressed together into "pack files".
 569
 570 Named pointers called refs mark interesting points in history.  A ref
 571 may contain the SHA1 name of an object or the name of another ref.  Refs
 572 with names beginning `ref/head/` contain the SHA1 name of the most
 573 recent commit (or "head") of a branch under development.  SHA1 names of
 574 tags of interest are stored under `ref/tags/`.  A special ref named
 575 `HEAD` contains the name of the currently checked-out branch.
 576
 577 The index file is initialized with a list of all paths and, for each
 578 path, a blob object and a set of attributes.  The blob object represents
 579 the contents of the file as of the head of the current branch.  The
 580 attributes (last modified time, size, etc.) are taken from the
 581 corresponding file in the working tree.  Subsequent changes to the
 582 working tree can be found by comparing these attributes.  The index may
 583 be updated with new content, and new commits may be created from the
 584 content stored in the index.
 585
 586 The index is also capable of storing multiple entries (called "stages")
 587 for a given pathname.  These stages are used to hold the various
 588 unmerged version of a file when a merge is in progress.
 589
 590 Authors
 591 -------
 592 * git's founding father is Linus Torvalds <torvalds@osdl.org>.
 593 * The current git nurse is Junio C Hamano <gitster@pobox.com>.
 594 * The git potty was written by Andreas Ericsson <ae@op5.se>.
 595 * General upbringing is handled by the git-list <git@vger.kernel.org>.
 596
 597 Documentation
 598 --------------
 599 The documentation for git suite was started by David Greaves
 600 <david@dgreaves.com>, and later enhanced greatly by the
 601 contributors on the git-list <git@vger.kernel.org>.
 602
 603 SEE ALSO
 604 --------
 605 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
 606 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
 607 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
 608 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual]
 609
 610 GIT
 611 ---
 612 Part of the linkgit:git[1] suite