Documentation / git.txton commit Doc: git.txt: remove backticks from link and add git-scm.com/docs (e2dca45)
   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|-P|--no-pager] [--no-replace-objects] [--bare]
  15    [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
  16    [--super-prefix=<path>]
  17    <command> [<args>]
  18
  19DESCRIPTION
  20-----------
  21Git is a fast, scalable, distributed revision control system with an
  22unusually rich command set that provides both high-level operations
  23and full access to internals.
  24
  25See linkgit:gittutorial[7] to get started, then see
  26linkgit:giteveryday[7] for a useful minimum set of
  27commands.  The link:user-manual.html[Git User's Manual] has a more
  28in-depth introduction.
  29
  30After you mastered the basic concepts, you can come back to this
  31page to learn what commands Git offers.  You can learn more about
  32individual Git commands with "git help command".  linkgit:gitcli[7]
  33manual page gives you an overview of the command-line command syntax.
  34
  35A formatted and hyperlinked copy of the latest Git documentation
  36can be viewed at https://git.github.io/htmldocs/git.html
  37or https://git-scm.com/docs.
  38
  39
  40OPTIONS
  41-------
  42--version::
  43        Prints the Git suite version that the 'git' program came from.
  44
  45--help::
  46        Prints the synopsis and a list of the most commonly used
  47        commands. If the option `--all` or `-a` is given then all
  48        available commands are printed. If a Git command is named this
  49        option will bring up the manual page for that command.
  50+
  51Other options are available to control how the manual page is
  52displayed. See linkgit:git-help[1] for more information,
  53because `git --help ...` is converted internally into `git
  54help ...`.
  55
  56-C <path>::
  57        Run as if git was started in '<path>' instead of the current working
  58        directory.  When multiple `-C` options are given, each subsequent
  59        non-absolute `-C <path>` is interpreted relative to the preceding `-C
  60        <path>`.
  61+
  62This option affects options that expect path name like `--git-dir` and
  63`--work-tree` in that their interpretations of the path names would be
  64made relative to the working directory caused by the `-C` option. For
  65example the following invocations are equivalent:
  66
  67    git --git-dir=a.git --work-tree=b -C c status
  68    git --git-dir=c/a.git --work-tree=c/b status
  69
  70-c <name>=<value>::
  71        Pass a configuration parameter to the command. The value
  72        given will override values from configuration files.
  73        The <name> is expected in the same format as listed by
  74        'git config' (subkeys separated by dots).
  75+
  76Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
  77`foo.bar` to the boolean true value (just like `[foo]bar` would in a
  78config file). Including the equals but with an empty value (like `git -c
  79foo.bar= ...`) sets `foo.bar` to the empty string which `git config
  80--type=bool` will convert to `false`.
  81
  82--exec-path[=<path>]::
  83        Path to wherever your core Git programs are installed.
  84        This can also be controlled by setting the GIT_EXEC_PATH
  85        environment variable. If no path is given, 'git' will print
  86        the current setting and then exit.
  87
  88--html-path::
  89        Print the path, without trailing slash, where Git's HTML
  90        documentation is installed and exit.
  91
  92--man-path::
  93        Print the manpath (see `man(1)`) for the man pages for
  94        this version of Git and exit.
  95
  96--info-path::
  97        Print the path where the Info files documenting this
  98        version of Git are installed and exit.
  99
 100-p::
 101--paginate::
 102        Pipe all output into 'less' (or if set, $PAGER) if standard
 103        output is a terminal.  This overrides the `pager.<cmd>`
 104        configuration options (see the "Configuration Mechanism" section
 105        below).
 106
 107-P::
 108--no-pager::
 109        Do not pipe Git output into a pager.
 110
 111--git-dir=<path>::
 112        Set the path to the repository. This can also be controlled by
 113        setting the `GIT_DIR` environment variable. It can be an absolute
 114        path or relative path to current working directory.
 115
 116--work-tree=<path>::
 117        Set the path to the working tree. It can be an absolute path
 118        or a path relative to the current working directory.
 119        This can also be controlled by setting the GIT_WORK_TREE
 120        environment variable and the core.worktree configuration
 121        variable (see core.worktree in linkgit:git-config[1] for a
 122        more detailed discussion).
 123
 124--namespace=<path>::
 125        Set the Git namespace.  See linkgit:gitnamespaces[7] for more
 126        details.  Equivalent to setting the `GIT_NAMESPACE` environment
 127        variable.
 128
 129--super-prefix=<path>::
 130        Currently for internal use only.  Set a prefix which gives a path from
 131        above a repository down to its root.  One use is to give submodules
 132        context about the superproject that invoked it.
 133
 134--bare::
 135        Treat the repository as a bare repository.  If GIT_DIR
 136        environment is not set, it is set to the current working
 137        directory.
 138
 139--no-replace-objects::
 140        Do not use replacement refs to replace Git objects. See
 141        linkgit:git-replace[1] for more information.
 142
 143--literal-pathspecs::
 144        Treat pathspecs literally (i.e. no globbing, no pathspec magic).
 145        This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
 146        variable to `1`.
 147
 148--glob-pathspecs::
 149        Add "glob" magic to all pathspec. This is equivalent to setting
 150        the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
 151        globbing on individual pathspecs can be done using pathspec
 152        magic ":(literal)"
 153
 154--noglob-pathspecs::
 155        Add "literal" magic to all pathspec. This is equivalent to setting
 156        the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
 157        globbing on individual pathspecs can be done using pathspec
 158        magic ":(glob)"
 159
 160--icase-pathspecs::
 161        Add "icase" magic to all pathspec. This is equivalent to setting
 162        the `GIT_ICASE_PATHSPECS` environment variable to `1`.
 163
 164--no-optional-locks::
 165        Do not perform optional operations that require locks. This is
 166        equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`.
 167
 168--list-cmds=group[,group...]::
 169        List commands by group. This is an internal/experimental
 170        option and may change or be removed in the future. Supported
 171        groups are: builtins, parseopt (builtin commands that use
 172        parse-options), main (all commands in libexec directory),
 173        others (all other commands in `$PATH` that have git- prefix),
 174        list-<category> (see categories in command-list.txt),
 175        nohelpers (exclude helper commands), alias and config
 176        (retrieve command list from config variable completion.commands)
 177
 178GIT COMMANDS
 179------------
 180
 181We divide Git into high level ("porcelain") commands and low level
 182("plumbing") commands.
 183
 184High-level commands (porcelain)
 185-------------------------------
 186
 187We separate the porcelain commands into the main commands and some
 188ancillary user utilities.
 189
 190Main porcelain commands
 191~~~~~~~~~~~~~~~~~~~~~~~
 192
 193include::cmds-mainporcelain.txt[]
 194
 195Ancillary Commands
 196~~~~~~~~~~~~~~~~~~
 197Manipulators:
 198
 199include::cmds-ancillarymanipulators.txt[]
 200
 201Interrogators:
 202
 203include::cmds-ancillaryinterrogators.txt[]
 204
 205
 206Interacting with Others
 207~~~~~~~~~~~~~~~~~~~~~~~
 208
 209These commands are to interact with foreign SCM and with other
 210people via patch over e-mail.
 211
 212include::cmds-foreignscminterface.txt[]
 213
 214
 215Low-level commands (plumbing)
 216-----------------------------
 217
 218Although Git includes its
 219own porcelain layer, its low-level commands are sufficient to support
 220development of alternative porcelains.  Developers of such porcelains
 221might start by reading about linkgit:git-update-index[1] and
 222linkgit:git-read-tree[1].
 223
 224The interface (input, output, set of options and the semantics)
 225to these low-level commands are meant to be a lot more stable
 226than Porcelain level commands, because these commands are
 227primarily for scripted use.  The interface to Porcelain commands
 228on the other hand are subject to change in order to improve the
 229end user experience.
 230
 231The following description divides
 232the low-level commands into commands that manipulate objects (in
 233the repository, index, and working tree), commands that interrogate and
 234compare objects, and commands that move objects and references between
 235repositories.
 236
 237
 238Manipulation commands
 239~~~~~~~~~~~~~~~~~~~~~
 240
 241include::cmds-plumbingmanipulators.txt[]
 242
 243
 244Interrogation commands
 245~~~~~~~~~~~~~~~~~~~~~~
 246
 247include::cmds-plumbinginterrogators.txt[]
 248
 249In general, the interrogate commands do not touch the files in
 250the working tree.
 251
 252
 253Synching repositories
 254~~~~~~~~~~~~~~~~~~~~~
 255
 256include::cmds-synchingrepositories.txt[]
 257
 258The following are helper commands used by the above; end users
 259typically do not use them directly.
 260
 261include::cmds-synchelpers.txt[]
 262
 263
 264Internal helper commands
 265~~~~~~~~~~~~~~~~~~~~~~~~
 266
 267These are internal helper commands used by other commands; end
 268users typically do not use them directly.
 269
 270include::cmds-purehelpers.txt[]
 271
 272
 273Configuration Mechanism
 274-----------------------
 275
 276Git uses a simple text format to store customizations that are per
 277repository and are per user.  Such a configuration file may look
 278like this:
 279
 280------------
 281#
 282# A '#' or ';' character indicates a comment.
 283#
 284
 285; core variables
 286[core]
 287        ; Don't trust file modes
 288        filemode = false
 289
 290; user identity
 291[user]
 292        name = "Junio C Hamano"
 293        email = "gitster@pobox.com"
 294
 295------------
 296
 297Various commands read from the configuration file and adjust
 298their operation accordingly.  See linkgit:git-config[1] for a
 299list and more details about the configuration mechanism.
 300
 301
 302Identifier Terminology
 303----------------------
 304<object>::
 305        Indicates the object name for any type of object.
 306
 307<blob>::
 308        Indicates a blob object name.
 309
 310<tree>::
 311        Indicates a tree object name.
 312
 313<commit>::
 314        Indicates a commit object name.
 315
 316<tree-ish>::
 317        Indicates a tree, commit or tag object name.  A
 318        command that takes a <tree-ish> argument ultimately wants to
 319        operate on a <tree> object but automatically dereferences
 320        <commit> and <tag> objects that point at a <tree>.
 321
 322<commit-ish>::
 323        Indicates a commit or tag object name.  A
 324        command that takes a <commit-ish> argument ultimately wants to
 325        operate on a <commit> object but automatically dereferences
 326        <tag> objects that point at a <commit>.
 327
 328<type>::
 329        Indicates that an object type is required.
 330        Currently one of: `blob`, `tree`, `commit`, or `tag`.
 331
 332<file>::
 333        Indicates a filename - almost always relative to the
 334        root of the tree structure `GIT_INDEX_FILE` describes.
 335
 336Symbolic Identifiers
 337--------------------
 338Any Git command accepting any <object> can also use the following
 339symbolic notation:
 340
 341HEAD::
 342        indicates the head of the current branch.
 343
 344<tag>::
 345        a valid tag 'name'
 346        (i.e. a `refs/tags/<tag>` reference).
 347
 348<head>::
 349        a valid head 'name'
 350        (i.e. a `refs/heads/<head>` reference).
 351
 352For a more complete list of ways to spell object names, see
 353"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
 354
 355
 356File/Directory Structure
 357------------------------
 358
 359Please see the linkgit:gitrepository-layout[5] document.
 360
 361Read linkgit:githooks[5] for more details about each hook.
 362
 363Higher level SCMs may provide and manage additional information in the
 364`$GIT_DIR`.
 365
 366
 367Terminology
 368-----------
 369Please see linkgit:gitglossary[7].
 370
 371
 372Environment Variables
 373---------------------
 374Various Git commands use the following environment variables:
 375
 376The Git Repository
 377~~~~~~~~~~~~~~~~~~
 378These environment variables apply to 'all' core Git commands. Nb: it
 379is worth noting that they may be used/overridden by SCMS sitting above
 380Git so take care if using a foreign front-end.
 381
 382`GIT_INDEX_FILE`::
 383        This environment allows the specification of an alternate
 384        index file. If not specified, the default of `$GIT_DIR/index`
 385        is used.
 386
 387`GIT_INDEX_VERSION`::
 388        This environment variable allows the specification of an index
 389        version for new repositories.  It won't affect existing index
 390        files.  By default index file version 2 or 3 is used. See
 391        linkgit:git-update-index[1] for more information.
 392
 393`GIT_OBJECT_DIRECTORY`::
 394        If the object storage directory is specified via this
 395        environment variable then the sha1 directories are created
 396        underneath - otherwise the default `$GIT_DIR/objects`
 397        directory is used.
 398
 399`GIT_ALTERNATE_OBJECT_DIRECTORIES`::
 400        Due to the immutable nature of Git objects, old objects can be
 401        archived into shared, read-only directories. This variable
 402        specifies a ":" separated (on Windows ";" separated) list
 403        of Git object directories which can be used to search for Git
 404        objects. New objects will not be written to these directories.
 405+
 406Entries that begin with `"` (double-quote) will be interpreted
 407as C-style quoted paths, removing leading and trailing
 408double-quotes and respecting backslash escapes. E.g., the value
 409`"path-with-\"-and-:-in-it":vanilla-path` has two paths:
 410`path-with-"-and-:-in-it` and `vanilla-path`.
 411
 412`GIT_DIR`::
 413        If the `GIT_DIR` environment variable is set then it
 414        specifies a path to use instead of the default `.git`
 415        for the base of the repository.
 416        The `--git-dir` command-line option also sets this value.
 417
 418`GIT_WORK_TREE`::
 419        Set the path to the root of the working tree.
 420        This can also be controlled by the `--work-tree` command-line
 421        option and the core.worktree configuration variable.
 422
 423`GIT_NAMESPACE`::
 424        Set the Git namespace; see linkgit:gitnamespaces[7] for details.
 425        The `--namespace` command-line option also sets this value.
 426
 427`GIT_CEILING_DIRECTORIES`::
 428        This should be a colon-separated list of absolute paths.  If
 429        set, it is a list of directories that Git should not chdir up
 430        into while looking for a repository directory (useful for
 431        excluding slow-loading network directories).  It will not
 432        exclude the current working directory or a GIT_DIR set on the
 433        command line or in the environment.  Normally, Git has to read
 434        the entries in this list and resolve any symlink that
 435        might be present in order to compare them with the current
 436        directory.  However, if even this access is slow, you
 437        can add an empty entry to the list to tell Git that the
 438        subsequent entries are not symlinks and needn't be resolved;
 439        e.g.,
 440        `GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
 441
 442`GIT_DISCOVERY_ACROSS_FILESYSTEM`::
 443        When run in a directory that does not have ".git" repository
 444        directory, Git tries to find such a directory in the parent
 445        directories to find the top of the working tree, but by default it
 446        does not cross filesystem boundaries.  This environment variable
 447        can be set to true to tell Git not to stop at filesystem
 448        boundaries.  Like `GIT_CEILING_DIRECTORIES`, this will not affect
 449        an explicit repository directory set via `GIT_DIR` or on the
 450        command line.
 451
 452`GIT_COMMON_DIR`::
 453        If this variable is set to a path, non-worktree files that are
 454        normally in $GIT_DIR will be taken from this path
 455        instead. Worktree-specific files such as HEAD or index are
 456        taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
 457        linkgit:git-worktree[1] for
 458        details. This variable has lower precedence than other path
 459        variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
 460
 461Git Commits
 462~~~~~~~~~~~
 463`GIT_AUTHOR_NAME`::
 464`GIT_AUTHOR_EMAIL`::
 465`GIT_AUTHOR_DATE`::
 466`GIT_COMMITTER_NAME`::
 467`GIT_COMMITTER_EMAIL`::
 468`GIT_COMMITTER_DATE`::
 469'EMAIL'::
 470        see linkgit:git-commit-tree[1]
 471
 472Git Diffs
 473~~~~~~~~~
 474`GIT_DIFF_OPTS`::
 475        Only valid setting is "--unified=??" or "-u??" to set the
 476        number of context lines shown when a unified diff is created.
 477        This takes precedence over any "-U" or "--unified" option
 478        value passed on the Git diff command line.
 479
 480`GIT_EXTERNAL_DIFF`::
 481        When the environment variable `GIT_EXTERNAL_DIFF` is set, the
 482        program named by it is called, instead of the diff invocation
 483        described above.  For a path that is added, removed, or modified,
 484        `GIT_EXTERNAL_DIFF` is called with 7 parameters:
 485
 486        path old-file old-hex old-mode new-file new-hex new-mode
 487+
 488where:
 489
 490        <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
 491                         contents of <old|new>,
 492        <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
 493        <old|new>-mode:: are the octal representation of the file modes.
 494+
 495The file parameters can point at the user's working file
 496(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
 497when a new file is added), or a temporary file (e.g. `old-file` in the
 498index).  `GIT_EXTERNAL_DIFF` should not worry about unlinking the
 499temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
 500+
 501For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
 502parameter, <path>.
 503+
 504For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
 505`GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
 506
 507`GIT_DIFF_PATH_COUNTER`::
 508        A 1-based counter incremented by one for every path.
 509
 510`GIT_DIFF_PATH_TOTAL`::
 511        The total number of paths.
 512
 513other
 514~~~~~
 515`GIT_MERGE_VERBOSITY`::
 516        A number controlling the amount of output shown by
 517        the recursive merge strategy.  Overrides merge.verbosity.
 518        See linkgit:git-merge[1]
 519
 520`GIT_PAGER`::
 521        This environment variable overrides `$PAGER`. If it is set
 522        to an empty string or to the value "cat", Git will not launch
 523        a pager.  See also the `core.pager` option in
 524        linkgit:git-config[1].
 525
 526`GIT_EDITOR`::
 527        This environment variable overrides `$EDITOR` and `$VISUAL`.
 528        It is used by several Git commands when, on interactive mode,
 529        an editor is to be launched. See also linkgit:git-var[1]
 530        and the `core.editor` option in linkgit:git-config[1].
 531
 532`GIT_SSH`::
 533`GIT_SSH_COMMAND`::
 534        If either of these environment variables is set then 'git fetch'
 535        and 'git push' will use the specified command instead of 'ssh'
 536        when they need to connect to a remote system.
 537        The command-line parameters passed to the configured command are
 538        determined by the ssh variant.  See `ssh.variant` option in
 539        linkgit:git-config[1] for details.
 540
 541+
 542`$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
 543by the shell, which allows additional arguments to be included.
 544`$GIT_SSH` on the other hand must be just the path to a program
 545(which can be a wrapper shell script, if additional arguments are
 546needed).
 547+
 548Usually it is easier to configure any desired options through your
 549personal `.ssh/config` file.  Please consult your ssh documentation
 550for further details.
 551
 552`GIT_SSH_VARIANT`::
 553        If this environment variable is set, it overrides Git's autodetection
 554        whether `GIT_SSH`/`GIT_SSH_COMMAND`/`core.sshCommand` refer to OpenSSH,
 555        plink or tortoiseplink. This variable overrides the config setting
 556        `ssh.variant` that serves the same purpose.
 557
 558`GIT_ASKPASS`::
 559        If this environment variable is set, then Git commands which need to
 560        acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
 561        will call this program with a suitable prompt as command-line argument
 562        and read the password from its STDOUT. See also the `core.askPass`
 563        option in linkgit:git-config[1].
 564
 565`GIT_TERMINAL_PROMPT`::
 566        If this environment variable is set to `0`, git will not prompt
 567        on the terminal (e.g., when asking for HTTP authentication).
 568
 569`GIT_CONFIG_NOSYSTEM`::
 570        Whether to skip reading settings from the system-wide
 571        `$(prefix)/etc/gitconfig` file.  This environment variable can
 572        be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
 573        predictable environment for a picky script, or you can set it
 574        temporarily to avoid using a buggy `/etc/gitconfig` file while
 575        waiting for someone with sufficient permissions to fix it.
 576
 577`GIT_FLUSH`::
 578        If this environment variable is set to "1", then commands such
 579        as 'git blame' (in incremental mode), 'git rev-list', 'git log',
 580        'git check-attr' and 'git check-ignore' will
 581        force a flush of the output stream after each record have been
 582        flushed. If this
 583        variable is set to "0", the output of these commands will be done
 584        using completely buffered I/O.   If this environment variable is
 585        not set, Git will choose buffered or record-oriented flushing
 586        based on whether stdout appears to be redirected to a file or not.
 587
 588`GIT_TRACE`::
 589        Enables general trace messages, e.g. alias expansion, built-in
 590        command execution and external command execution.
 591+
 592If this variable is set to "1", "2" or "true" (comparison
 593is case insensitive), trace messages will be printed to
 594stderr.
 595+
 596If the variable is set to an integer value greater than 2
 597and lower than 10 (strictly) then Git will interpret this
 598value as an open file descriptor and will try to write the
 599trace messages into this file descriptor.
 600+
 601Alternatively, if the variable is set to an absolute path
 602(starting with a '/' character), Git will interpret this
 603as a file path and will try to append the trace messages
 604to it.
 605+
 606Unsetting the variable, or setting it to empty, "0" or
 607"false" (case insensitive) disables trace messages.
 608
 609`GIT_TRACE_FSMONITOR`::
 610        Enables trace messages for the filesystem monitor extension.
 611        See `GIT_TRACE` for available trace output options.
 612
 613`GIT_TRACE_PACK_ACCESS`::
 614        Enables trace messages for all accesses to any packs. For each
 615        access, the pack file name and an offset in the pack is
 616        recorded. This may be helpful for troubleshooting some
 617        pack-related performance problems.
 618        See `GIT_TRACE` for available trace output options.
 619
 620`GIT_TRACE_PACKET`::
 621        Enables trace messages for all packets coming in or out of a
 622        given program. This can help with debugging object negotiation
 623        or other protocol issues. Tracing is turned off at a packet
 624        starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
 625        See `GIT_TRACE` for available trace output options.
 626
 627`GIT_TRACE_PACKFILE`::
 628        Enables tracing of packfiles sent or received by a
 629        given program. Unlike other trace output, this trace is
 630        verbatim: no headers, and no quoting of binary data. You almost
 631        certainly want to direct into a file (e.g.,
 632        `GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
 633        the terminal or mixing it with other trace output.
 634+
 635Note that this is currently only implemented for the client side
 636of clones and fetches.
 637
 638`GIT_TRACE_PERFORMANCE`::
 639        Enables performance related trace messages, e.g. total execution
 640        time of each Git command.
 641        See `GIT_TRACE` for available trace output options.
 642
 643`GIT_TRACE_SETUP`::
 644        Enables trace messages printing the .git, working tree and current
 645        working directory after Git has completed its setup phase.
 646        See `GIT_TRACE` for available trace output options.
 647
 648`GIT_TRACE_SHALLOW`::
 649        Enables trace messages that can help debugging fetching /
 650        cloning of shallow repositories.
 651        See `GIT_TRACE` for available trace output options.
 652
 653`GIT_TRACE_CURL`::
 654        Enables a curl full trace dump of all incoming and outgoing data,
 655        including descriptive information, of the git transport protocol.
 656        This is similar to doing curl `--trace-ascii` on the command line.
 657        This option overrides setting the `GIT_CURL_VERBOSE` environment
 658        variable.
 659        See `GIT_TRACE` for available trace output options.
 660
 661`GIT_TRACE_CURL_NO_DATA`::
 662        When a curl trace is enabled (see `GIT_TRACE_CURL` above), do not dump
 663        data (that is, only dump info lines and headers).
 664
 665`GIT_REDACT_COOKIES`::
 666        This can be set to a comma-separated list of strings. When a curl trace
 667        is enabled (see `GIT_TRACE_CURL` above), whenever a "Cookies:" header
 668        sent by the client is dumped, values of cookies whose key is in that
 669        list (case-sensitive) are redacted.
 670
 671`GIT_LITERAL_PATHSPECS`::
 672        Setting this variable to `1` will cause Git to treat all
 673        pathspecs literally, rather than as glob patterns. For example,
 674        running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
 675        for commits that touch the path `*.c`, not any paths that the
 676        glob `*.c` matches. You might want this if you are feeding
 677        literal paths to Git (e.g., paths previously given to you by
 678        `git ls-tree`, `--raw` diff output, etc).
 679
 680`GIT_GLOB_PATHSPECS`::
 681        Setting this variable to `1` will cause Git to treat all
 682        pathspecs as glob patterns (aka "glob" magic).
 683
 684`GIT_NOGLOB_PATHSPECS`::
 685        Setting this variable to `1` will cause Git to treat all
 686        pathspecs as literal (aka "literal" magic).
 687
 688`GIT_ICASE_PATHSPECS`::
 689        Setting this variable to `1` will cause Git to treat all
 690        pathspecs as case-insensitive.
 691
 692`GIT_REFLOG_ACTION`::
 693        When a ref is updated, reflog entries are created to keep
 694        track of the reason why the ref was updated (which is
 695        typically the name of the high-level command that updated
 696        the ref), in addition to the old and new values of the ref.
 697        A scripted Porcelain command can use set_reflog_action
 698        helper function in `git-sh-setup` to set its name to this
 699        variable when it is invoked as the top level command by the
 700        end user, to be recorded in the body of the reflog.
 701
 702`GIT_REF_PARANOIA`::
 703        If set to `1`, include broken or badly named refs when iterating
 704        over lists of refs. In a normal, non-corrupted repository, this
 705        does nothing. However, enabling it may help git to detect and
 706        abort some operations in the presence of broken refs. Git sets
 707        this variable automatically when performing destructive
 708        operations like linkgit:git-prune[1]. You should not need to set
 709        it yourself unless you want to be paranoid about making sure
 710        an operation has touched every ref (e.g., because you are
 711        cloning a repository to make a backup).
 712
 713`GIT_ALLOW_PROTOCOL`::
 714        If set to a colon-separated list of protocols, behave as if
 715        `protocol.allow` is set to `never`, and each of the listed
 716        protocols has `protocol.<name>.allow` set to `always`
 717        (overriding any existing configuration). In other words, any
 718        protocol not mentioned will be disallowed (i.e., this is a
 719        whitelist, not a blacklist). See the description of
 720        `protocol.allow` in linkgit:git-config[1] for more details.
 721
 722`GIT_PROTOCOL_FROM_USER`::
 723        Set to 0 to prevent protocols used by fetch/push/clone which are
 724        configured to the `user` state.  This is useful to restrict recursive
 725        submodule initialization from an untrusted repository or for programs
 726        which feed potentially-untrusted URLS to git commands.  See
 727        linkgit:git-config[1] for more details.
 728
 729`GIT_PROTOCOL`::
 730        For internal use only.  Used in handshaking the wire protocol.
 731        Contains a colon ':' separated list of keys with optional values
 732        'key[=value]'.  Presence of unknown keys and values must be
 733        ignored.
 734
 735`GIT_OPTIONAL_LOCKS`::
 736        If set to `0`, Git will complete any requested operation without
 737        performing any optional sub-operations that require taking a lock.
 738        For example, this will prevent `git status` from refreshing the
 739        index as a side effect. This is useful for processes running in
 740        the background which do not want to cause lock contention with
 741        other operations on the repository.  Defaults to `1`.
 742
 743`GIT_REDIRECT_STDIN`::
 744`GIT_REDIRECT_STDOUT`::
 745`GIT_REDIRECT_STDERR`::
 746        Windows-only: allow redirecting the standard input/output/error
 747        handles to paths specified by the environment variables. This is
 748        particularly useful in multi-threaded applications where the
 749        canonical way to pass standard handles via `CreateProcess()` is
 750        not an option because it would require the handles to be marked
 751        inheritable (and consequently *every* spawned process would
 752        inherit them, possibly blocking regular Git operations). The
 753        primary intended use case is to use named pipes for communication
 754        (e.g. `\\.\pipe\my-git-stdin-123`).
 755+
 756Two special values are supported: `off` will simply close the
 757corresponding standard handle, and if `GIT_REDIRECT_STDERR` is
 758`2>&1`, standard error will be redirected to the same handle as
 759standard output.
 760
 761`GIT_PRINT_SHA1_ELLIPSIS` (deprecated)::
 762        If set to `yes`, print an ellipsis following an
 763        (abbreviated) SHA-1 value.  This affects indications of
 764        detached HEADs (linkgit:git-checkout[1]) and the raw
 765        diff output (linkgit:git-diff[1]).  Printing an
 766        ellipsis in the cases mentioned is no longer considered
 767        adequate and support for it is likely to be removed in the
 768        foreseeable future (along with the variable).
 769
 770Discussion[[Discussion]]
 771------------------------
 772
 773More detail on the following is available from the
 774link:user-manual.html#git-concepts[Git concepts chapter of the
 775user-manual] and linkgit:gitcore-tutorial[7].
 776
 777A Git project normally consists of a working directory with a ".git"
 778subdirectory at the top level.  The .git directory contains, among other
 779things, a compressed object database representing the complete history
 780of the project, an "index" file which links that history to the current
 781contents of the working tree, and named pointers into that history such
 782as tags and branch heads.
 783
 784The object database contains objects of three main types: blobs, which
 785hold file data; trees, which point to blobs and other trees to build up
 786directory hierarchies; and commits, which each reference a single tree
 787and some number of parent commits.
 788
 789The commit, equivalent to what other systems call a "changeset" or
 790"version", represents a step in the project's history, and each parent
 791represents an immediately preceding step.  Commits with more than one
 792parent represent merges of independent lines of development.
 793
 794All objects are named by the SHA-1 hash of their contents, normally
 795written as a string of 40 hex digits.  Such names are globally unique.
 796The entire history leading up to a commit can be vouched for by signing
 797just that commit.  A fourth object type, the tag, is provided for this
 798purpose.
 799
 800When first created, objects are stored in individual files, but for
 801efficiency may later be compressed together into "pack files".
 802
 803Named pointers called refs mark interesting points in history.  A ref
 804may contain the SHA-1 name of an object or the name of another ref.  Refs
 805with names beginning `ref/head/` contain the SHA-1 name of the most
 806recent commit (or "head") of a branch under development.  SHA-1 names of
 807tags of interest are stored under `ref/tags/`.  A special ref named
 808`HEAD` contains the name of the currently checked-out branch.
 809
 810The index file is initialized with a list of all paths and, for each
 811path, a blob object and a set of attributes.  The blob object represents
 812the contents of the file as of the head of the current branch.  The
 813attributes (last modified time, size, etc.) are taken from the
 814corresponding file in the working tree.  Subsequent changes to the
 815working tree can be found by comparing these attributes.  The index may
 816be updated with new content, and new commits may be created from the
 817content stored in the index.
 818
 819The index is also capable of storing multiple entries (called "stages")
 820for a given pathname.  These stages are used to hold the various
 821unmerged version of a file when a merge is in progress.
 822
 823FURTHER DOCUMENTATION
 824---------------------
 825
 826See the references in the "description" section to get started
 827using Git.  The following is probably more detail than necessary
 828for a first-time user.
 829
 830The link:user-manual.html#git-concepts[Git concepts chapter of the
 831user-manual] and linkgit:gitcore-tutorial[7] both provide
 832introductions to the underlying Git architecture.
 833
 834See linkgit:gitworkflows[7] for an overview of recommended workflows.
 835
 836See also the link:howto-index.html[howto] documents for some useful
 837examples.
 838
 839The internals are documented in the
 840link:technical/api-index.html[Git API documentation].
 841
 842Users migrating from CVS may also want to
 843read linkgit:gitcvs-migration[7].
 844
 845
 846Authors
 847-------
 848Git was started by Linus Torvalds, and is currently maintained by Junio
 849C Hamano. Numerous contributions have come from the Git mailing list
 850<git@vger.kernel.org>.  http://www.openhub.net/p/git/contributors/summary
 851gives you a more complete list of contributors.
 852
 853If you have a clone of git.git itself, the
 854output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
 855the authors for specific parts of the project.
 856
 857Reporting Bugs
 858--------------
 859
 860Report bugs to the Git mailing list <git@vger.kernel.org> where the
 861development and maintenance is primarily done.  You do not have to be
 862subscribed to the list to send a message there.  See the list archive
 863at https://public-inbox.org/git for previous bug reports and other
 864discussions.
 865
 866Issues which are security relevant should be disclosed privately to
 867the Git Security mailing list <git-security@googlegroups.com>.
 868
 869SEE ALSO
 870--------
 871linkgit:gittutorial[7], linkgit:gittutorial-2[7],
 872linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
 873linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
 874linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
 875linkgit:gitworkflows[7]
 876
 877GIT
 878---
 879Part of the linkgit:git[1] suite