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