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