Autogenerated manpages for v2.34.1-428-gdcc0c
[git-manpages.git] / man1 / git.1
blobf61f2fc8c7b34e7ca5aecc2ede84a7fc237d93dc
1 '\" t
2 .\"     Title: git
3 .\"    Author: [see the "Authors" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 01/03/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.34.1.428.gdcc0cd074f
8 .\"  Language: English
9 .\"
10 .TH "GIT" "1" "01/03/2022" "Git 2\&.34\&.1\&.428\&.gdcc0cd" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git \- the stupid content tracker
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit\fR [\-\-version] [\-\-help] [\-C <path>] [\-c <name>=<value>]
36     [\-\-exec\-path[=<path>]] [\-\-html\-path] [\-\-man\-path] [\-\-info\-path]
37     [\-p|\-\-paginate|\-P|\-\-no\-pager] [\-\-no\-replace\-objects] [\-\-bare]
38     [\-\-git\-dir=<path>] [\-\-work\-tree=<path>] [\-\-namespace=<name>]
39     [\-\-super\-prefix=<path>] [\-\-config\-env=<name>=<envvar>]
40     <command> [<args>]
41 .fi
42 .sp
43 .SH "DESCRIPTION"
44 .sp
45 Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high\-level operations and full access to internals\&.
46 .sp
47 See \fBgittutorial\fR(7) to get started, then see \fBgiteveryday\fR(7) for a useful minimum set of commands\&. The \m[blue]\fBGit User\(cqs Manual\fR\m[]\&\s-2\u[1]\d\s+2 has a more in\-depth introduction\&.
48 .sp
49 After you mastered the basic concepts, you can come back to this page to learn what commands Git offers\&. You can learn more about individual Git commands with "git help command"\&. \fBgitcli\fR(7) manual page gives you an overview of the command\-line command syntax\&.
50 .sp
51 A formatted and hyperlinked copy of the latest Git documentation can be viewed at \m[blue]\fBhttps://git\&.github\&.io/htmldocs/git\&.html\fR\m[] or \m[blue]\fBhttps://git\-scm\&.com/docs\fR\m[]\&.
52 .SH "OPTIONS"
53 .PP
54 \-\-version
55 .RS 4
56 Prints the Git suite version that the
57 \fIgit\fR
58 program came from\&.
59 .sp
60 This option is internally converted to
61 \fBgit version \&.\&.\&.\fR
62 and accepts the same options as the
63 \fBgit-version\fR(1)
64 command\&. If
65 \fB\-\-help\fR
66 is also given, it takes precedence over
67 \fB\-\-version\fR\&.
68 .RE
69 .PP
70 \-\-help
71 .RS 4
72 Prints the synopsis and a list of the most commonly used commands\&. If the option
73 \fB\-\-all\fR
75 \fB\-a\fR
76 is given then all available commands are printed\&. If a Git command is named this option will bring up the manual page for that command\&.
77 .sp
78 Other options are available to control how the manual page is displayed\&. See
79 \fBgit-help\fR(1)
80 for more information, because
81 \fBgit \-\-help \&.\&.\&.\fR
82 is converted internally into
83 \fBgit help \&.\&.\&.\fR\&.
84 .RE
85 .PP
86 \-C <path>
87 .RS 4
88 Run as if git was started in
89 \fI<path>\fR
90 instead of the current working directory\&. When multiple
91 \fB\-C\fR
92 options are given, each subsequent non\-absolute
93 \fB\-C <path>\fR
94 is interpreted relative to the preceding
95 \fB\-C <path>\fR\&. If
96 \fI<path>\fR
97 is present but empty, e\&.g\&.
98 \fB\-C ""\fR, then the current working directory is left unchanged\&.
99 .sp
100 This option affects options that expect path name like
101 \fB\-\-git\-dir\fR
103 \fB\-\-work\-tree\fR
104 in that their interpretations of the path names would be made relative to the working directory caused by the
105 \fB\-C\fR
106 option\&. For example the following invocations are equivalent:
108 .if n \{\
109 .RS 4
112 git \-\-git\-dir=a\&.git \-\-work\-tree=b \-C c status
113 git \-\-git\-dir=c/a\&.git \-\-work\-tree=c/b status
115 .if n \{\
120 \-c <name>=<value>
121 .RS 4
122 Pass a configuration parameter to the command\&. The value given will override values from configuration files\&. The <name> is expected in the same format as listed by
123 \fIgit config\fR
124 (subkeys separated by dots)\&.
126 Note that omitting the
127 \fB=\fR
129 \fBgit \-c foo\&.bar \&.\&.\&.\fR
130 is allowed and sets
131 \fBfoo\&.bar\fR
132 to the boolean true value (just like
133 \fB[foo]bar\fR
134 would in a config file)\&. Including the equals but with an empty value (like
135 \fBgit \-c foo\&.bar= \&.\&.\&.\fR) sets
136 \fBfoo\&.bar\fR
137 to the empty string which
138 \fBgit config \-\-type=bool\fR
139 will convert to
140 \fBfalse\fR\&.
143 \-\-config\-env=<name>=<envvar>
144 .RS 4
145 Like
146 \fB\-c <name>=<value>\fR, give configuration variable
147 \fI<name>\fR
148 a value, where <envvar> is the name of an environment variable from which to retrieve the value\&. Unlike
149 \fB\-c\fR
150 there is no shortcut for directly setting the value to an empty string, instead the environment variable itself must be set to the empty string\&. It is an error if the
151 \fB<envvar>\fR
152 does not exist in the environment\&.
153 \fB<envvar>\fR
154 may not contain an equals sign to avoid ambiguity with
155 \fB<name>\fR
156 containing one\&.
158 This is useful for cases where you want to pass transitory configuration options to git, but are doing so on OS\(cqs where other processes might be able to read your cmdline (e\&.g\&.
159 \fB/proc/self/cmdline\fR), but not your environ (e\&.g\&.
160 \fB/proc/self/environ\fR)\&. That behavior is the default on Linux, but may not be on your system\&.
162 Note that this might add security for variables such as
163 \fBhttp\&.extraHeader\fR
164 where the sensitive information is part of the value, but not e\&.g\&.
165 \fBurl\&.<base>\&.insteadOf\fR
166 where the sensitive information can be part of the key\&.
169 \-\-exec\-path[=<path>]
170 .RS 4
171 Path to wherever your core Git programs are installed\&. This can also be controlled by setting the GIT_EXEC_PATH environment variable\&. If no path is given,
172 \fIgit\fR
173 will print the current setting and then exit\&.
176 \-\-html\-path
177 .RS 4
178 Print the path, without trailing slash, where Git\(cqs HTML documentation is installed and exit\&.
181 \-\-man\-path
182 .RS 4
183 Print the manpath (see
184 \fBman(1)\fR) for the man pages for this version of Git and exit\&.
187 \-\-info\-path
188 .RS 4
189 Print the path where the Info files documenting this version of Git are installed and exit\&.
192 \-p, \-\-paginate
193 .RS 4
194 Pipe all output into
195 \fIless\fR
196 (or if set, $PAGER) if standard output is a terminal\&. This overrides the
197 \fBpager\&.<cmd>\fR
198 configuration options (see the "Configuration Mechanism" section below)\&.
201 \-P, \-\-no\-pager
202 .RS 4
203 Do not pipe Git output into a pager\&.
206 \-\-git\-dir=<path>
207 .RS 4
208 Set the path to the repository ("\&.git" directory)\&. This can also be controlled by setting the
209 \fBGIT_DIR\fR
210 environment variable\&. It can be an absolute path or relative path to current working directory\&.
212 Specifying the location of the "\&.git" directory using this option (or
213 \fBGIT_DIR\fR
214 environment variable) turns off the repository discovery that tries to find a directory with "\&.git" subdirectory (which is how the repository and the top\-level of the working tree are discovered), and tells Git that you are at the top level of the working tree\&. If you are not at the top\-level directory of the working tree, you should tell Git where the top\-level of the working tree is, with the
215 \fB\-\-work\-tree=<path>\fR
216 option (or
217 \fBGIT_WORK_TREE\fR
218 environment variable)
220 If you just want to run git as if it was started in
221 \fB<path>\fR
222 then use
223 \fBgit \-C <path>\fR\&.
226 \-\-work\-tree=<path>
227 .RS 4
228 Set the path to the working tree\&. It can be an absolute path or a path relative to the current working directory\&. This can also be controlled by setting the GIT_WORK_TREE environment variable and the core\&.worktree configuration variable (see core\&.worktree in
229 \fBgit-config\fR(1)
230 for a more detailed discussion)\&.
233 \-\-namespace=<path>
234 .RS 4
235 Set the Git namespace\&. See
236 \fBgitnamespaces\fR(7)
237 for more details\&. Equivalent to setting the
238 \fBGIT_NAMESPACE\fR
239 environment variable\&.
242 \-\-super\-prefix=<path>
243 .RS 4
244 Currently for internal use only\&. Set a prefix which gives a path from above a repository down to its root\&. One use is to give submodules context about the superproject that invoked it\&.
247 \-\-bare
248 .RS 4
249 Treat the repository as a bare repository\&. If GIT_DIR environment is not set, it is set to the current working directory\&.
252 \-\-no\-replace\-objects
253 .RS 4
254 Do not use replacement refs to replace Git objects\&. See
255 \fBgit-replace\fR(1)
256 for more information\&.
259 \-\-literal\-pathspecs
260 .RS 4
261 Treat pathspecs literally (i\&.e\&. no globbing, no pathspec magic)\&. This is equivalent to setting the
262 \fBGIT_LITERAL_PATHSPECS\fR
263 environment variable to
264 \fB1\fR\&.
267 \-\-glob\-pathspecs
268 .RS 4
269 Add "glob" magic to all pathspec\&. This is equivalent to setting the
270 \fBGIT_GLOB_PATHSPECS\fR
271 environment variable to
272 \fB1\fR\&. Disabling globbing on individual pathspecs can be done using pathspec magic ":(literal)"
275 \-\-noglob\-pathspecs
276 .RS 4
277 Add "literal" magic to all pathspec\&. This is equivalent to setting the
278 \fBGIT_NOGLOB_PATHSPECS\fR
279 environment variable to
280 \fB1\fR\&. Enabling globbing on individual pathspecs can be done using pathspec magic ":(glob)"
283 \-\-icase\-pathspecs
284 .RS 4
285 Add "icase" magic to all pathspec\&. This is equivalent to setting the
286 \fBGIT_ICASE_PATHSPECS\fR
287 environment variable to
288 \fB1\fR\&.
291 \-\-no\-optional\-locks
292 .RS 4
293 Do not perform optional operations that require locks\&. This is equivalent to setting the
294 \fBGIT_OPTIONAL_LOCKS\fR
296 \fB0\fR\&.
299 \-\-list\-cmds=group[,group\&...]
300 .RS 4
301 List commands by group\&. This is an internal/experimental option and may change or be removed in the future\&. Supported groups are: builtins, parseopt (builtin commands that use parse\-options), main (all commands in libexec directory), others (all other commands in
302 \fB$PATH\fR
303 that have git\- prefix), list\-<category> (see categories in command\-list\&.txt), nohelpers (exclude helper commands), alias and config (retrieve command list from config variable completion\&.commands)
305 .SH "GIT COMMANDS"
307 We divide Git into high level ("porcelain") commands and low level ("plumbing") commands\&.
308 .SH "HIGH\-LEVEL COMMANDS (PORCELAIN)"
310 We separate the porcelain commands into the main commands and some ancillary user utilities\&.
311 .SS "Main porcelain commands"
313 \fBgit-add\fR(1)
314 .RS 4
315 Add file contents to the index\&.
318 \fBgit-am\fR(1)
319 .RS 4
320 Apply a series of patches from a mailbox\&.
323 \fBgit-archive\fR(1)
324 .RS 4
325 Create an archive of files from a named tree\&.
328 \fBgit-bisect\fR(1)
329 .RS 4
330 Use binary search to find the commit that introduced a bug\&.
333 \fBgit-branch\fR(1)
334 .RS 4
335 List, create, or delete branches\&.
338 \fBgit-bundle\fR(1)
339 .RS 4
340 Move objects and refs by archive\&.
343 \fBgit-checkout\fR(1)
344 .RS 4
345 Switch branches or restore working tree files\&.
348 \fBgit-cherry-pick\fR(1)
349 .RS 4
350 Apply the changes introduced by some existing commits\&.
353 \fBgit-citool\fR(1)
354 .RS 4
355 Graphical alternative to git\-commit\&.
358 \fBgit-clean\fR(1)
359 .RS 4
360 Remove untracked files from the working tree\&.
363 \fBgit-clone\fR(1)
364 .RS 4
365 Clone a repository into a new directory\&.
368 \fBgit-commit\fR(1)
369 .RS 4
370 Record changes to the repository\&.
373 \fBgit-describe\fR(1)
374 .RS 4
375 Give an object a human readable name based on an available ref\&.
378 \fBgit-diff\fR(1)
379 .RS 4
380 Show changes between commits, commit and working tree, etc\&.
383 \fBgit-fetch\fR(1)
384 .RS 4
385 Download objects and refs from another repository\&.
388 \fBgit-format-patch\fR(1)
389 .RS 4
390 Prepare patches for e\-mail submission\&.
393 \fBgit-gc\fR(1)
394 .RS 4
395 Cleanup unnecessary files and optimize the local repository\&.
398 \fBgit-grep\fR(1)
399 .RS 4
400 Print lines matching a pattern\&.
403 \fBgit-gui\fR(1)
404 .RS 4
405 A portable graphical interface to Git\&.
408 \fBgit-init\fR(1)
409 .RS 4
410 Create an empty Git repository or reinitialize an existing one\&.
413 \fBgit-log\fR(1)
414 .RS 4
415 Show commit logs\&.
418 \fBgit-maintenance\fR(1)
419 .RS 4
420 Run tasks to optimize Git repository data\&.
423 \fBgit-merge\fR(1)
424 .RS 4
425 Join two or more development histories together\&.
428 \fBgit-mv\fR(1)
429 .RS 4
430 Move or rename a file, a directory, or a symlink\&.
433 \fBgit-notes\fR(1)
434 .RS 4
435 Add or inspect object notes\&.
438 \fBgit-pull\fR(1)
439 .RS 4
440 Fetch from and integrate with another repository or a local branch\&.
443 \fBgit-push\fR(1)
444 .RS 4
445 Update remote refs along with associated objects\&.
448 \fBgit-range-diff\fR(1)
449 .RS 4
450 Compare two commit ranges (e\&.g\&. two versions of a branch)\&.
453 \fBgit-rebase\fR(1)
454 .RS 4
455 Reapply commits on top of another base tip\&.
458 \fBgit-reset\fR(1)
459 .RS 4
460 Reset current HEAD to the specified state\&.
463 \fBgit-restore\fR(1)
464 .RS 4
465 Restore working tree files\&.
468 \fBgit-revert\fR(1)
469 .RS 4
470 Revert some existing commits\&.
473 \fBgit-rm\fR(1)
474 .RS 4
475 Remove files from the working tree and from the index\&.
478 \fBgit-shortlog\fR(1)
479 .RS 4
480 Summarize
481 \fIgit log\fR
482 output\&.
485 \fBgit-show\fR(1)
486 .RS 4
487 Show various types of objects\&.
490 \fBgit-sparse-checkout\fR(1)
491 .RS 4
492 Initialize and modify the sparse\-checkout\&.
495 \fBgit-stash\fR(1)
496 .RS 4
497 Stash the changes in a dirty working directory away\&.
500 \fBgit-status\fR(1)
501 .RS 4
502 Show the working tree status\&.
505 \fBgit-submodule\fR(1)
506 .RS 4
507 Initialize, update or inspect submodules\&.
510 \fBgit-switch\fR(1)
511 .RS 4
512 Switch branches\&.
515 \fBgit-tag\fR(1)
516 .RS 4
517 Create, list, delete or verify a tag object signed with GPG\&.
520 \fBgit-worktree\fR(1)
521 .RS 4
522 Manage multiple working trees\&.
525 \fBgitk\fR(1)
526 .RS 4
527 The Git repository browser\&.
529 .SS "Ancillary Commands"
531 Manipulators:
533 \fBgit-config\fR(1)
534 .RS 4
535 Get and set repository or global options\&.
538 \fBgit-fast-export\fR(1)
539 .RS 4
540 Git data exporter\&.
543 \fBgit-fast-import\fR(1)
544 .RS 4
545 Backend for fast Git data importers\&.
548 \fBgit-filter-branch\fR(1)
549 .RS 4
550 Rewrite branches\&.
553 \fBgit-mergetool\fR(1)
554 .RS 4
555 Run merge conflict resolution tools to resolve merge conflicts\&.
558 \fBgit-pack-refs\fR(1)
559 .RS 4
560 Pack heads and tags for efficient repository access\&.
563 \fBgit-prune\fR(1)
564 .RS 4
565 Prune all unreachable objects from the object database\&.
568 \fBgit-reflog\fR(1)
569 .RS 4
570 Manage reflog information\&.
573 \fBgit-remote\fR(1)
574 .RS 4
575 Manage set of tracked repositories\&.
578 \fBgit-repack\fR(1)
579 .RS 4
580 Pack unpacked objects in a repository\&.
583 \fBgit-replace\fR(1)
584 .RS 4
585 Create, list, delete refs to replace objects\&.
588 Interrogators:
590 \fBgit-annotate\fR(1)
591 .RS 4
592 Annotate file lines with commit information\&.
595 \fBgit-blame\fR(1)
596 .RS 4
597 Show what revision and author last modified each line of a file\&.
600 \fBgit-bugreport\fR(1)
601 .RS 4
602 Collect information for user to file a bug report\&.
605 \fBgit-count-objects\fR(1)
606 .RS 4
607 Count unpacked number of objects and their disk consumption\&.
610 \fBgit-difftool\fR(1)
611 .RS 4
612 Show changes using common diff tools\&.
615 \fBgit-fsck\fR(1)
616 .RS 4
617 Verifies the connectivity and validity of the objects in the database\&.
620 \fBgit-help\fR(1)
621 .RS 4
622 Display help information about Git\&.
625 \fBgit-instaweb\fR(1)
626 .RS 4
627 Instantly browse your working repository in gitweb\&.
630 \fBgit-merge-tree\fR(1)
631 .RS 4
632 Show three\-way merge without touching index\&.
635 \fBgit-rerere\fR(1)
636 .RS 4
637 Reuse recorded resolution of conflicted merges\&.
640 \fBgit-show-branch\fR(1)
641 .RS 4
642 Show branches and their commits\&.
645 \fBgit-verify-commit\fR(1)
646 .RS 4
647 Check the GPG signature of commits\&.
650 \fBgit-verify-tag\fR(1)
651 .RS 4
652 Check the GPG signature of tags\&.
655 \fBgit-whatchanged\fR(1)
656 .RS 4
657 Show logs with difference each commit introduces\&.
660 \fBgitweb\fR(1)
661 .RS 4
662 Git web interface (web frontend to Git repositories)\&.
664 .SS "Interacting with Others"
666 These commands are to interact with foreign SCM and with other people via patch over e\-mail\&.
668 \fBgit-archimport\fR(1)
669 .RS 4
670 Import a GNU Arch repository into Git\&.
673 \fBgit-cvsexportcommit\fR(1)
674 .RS 4
675 Export a single commit to a CVS checkout\&.
678 \fBgit-cvsimport\fR(1)
679 .RS 4
680 Salvage your data out of another SCM people love to hate\&.
683 \fBgit-cvsserver\fR(1)
684 .RS 4
685 A CVS server emulator for Git\&.
688 \fBgit-imap-send\fR(1)
689 .RS 4
690 Send a collection of patches from stdin to an IMAP folder\&.
693 \fBgit-p4\fR(1)
694 .RS 4
695 Import from and submit to Perforce repositories\&.
698 \fBgit-quiltimport\fR(1)
699 .RS 4
700 Applies a quilt patchset onto the current branch\&.
703 \fBgit-request-pull\fR(1)
704 .RS 4
705 Generates a summary of pending changes\&.
708 \fBgit-send-email\fR(1)
709 .RS 4
710 Send a collection of patches as emails\&.
713 \fBgit-svn\fR(1)
714 .RS 4
715 Bidirectional operation between a Subversion repository and Git\&.
717 .SS "Reset, restore and revert"
719 There are three commands with similar names: \fBgit reset\fR, \fBgit restore\fR and \fBgit revert\fR\&.
721 .RS 4
722 .ie n \{\
723 \h'-04'\(bu\h'+03'\c
725 .el \{\
726 .sp -1
727 .IP \(bu 2.3
729 \fBgit-revert\fR(1)
730 is about making a new commit that reverts the changes made by other commits\&.
733 .RS 4
734 .ie n \{\
735 \h'-04'\(bu\h'+03'\c
737 .el \{\
738 .sp -1
739 .IP \(bu 2.3
741 \fBgit-restore\fR(1)
742 is about restoring files in the working tree from either the index or another commit\&. This command does not update your branch\&. The command can also be used to restore files in the index from another commit\&.
745 .RS 4
746 .ie n \{\
747 \h'-04'\(bu\h'+03'\c
749 .el \{\
750 .sp -1
751 .IP \(bu 2.3
753 \fBgit-reset\fR(1)
754 is about updating your branch, moving the tip in order to add or remove commits from the branch\&. This operation changes the commit history\&.
756 \fBgit reset\fR
757 can also be used to restore the index, overlapping with
758 \fBgit restore\fR\&.
760 .SH "LOW\-LEVEL COMMANDS (PLUMBING)"
762 Although Git includes its own porcelain layer, its low\-level commands are sufficient to support development of alternative porcelains\&. Developers of such porcelains might start by reading about \fBgit-update-index\fR(1) and \fBgit-read-tree\fR(1)\&.
764 The interface (input, output, set of options and the semantics) to these low\-level commands are meant to be a lot more stable than Porcelain level commands, because these commands are primarily for scripted use\&. The interface to Porcelain commands on the other hand are subject to change in order to improve the end user experience\&.
766 The following description divides the low\-level commands into commands that manipulate objects (in the repository, index, and working tree), commands that interrogate and compare objects, and commands that move objects and references between repositories\&.
767 .SS "Manipulation commands"
769 \fBgit-apply\fR(1)
770 .RS 4
771 Apply a patch to files and/or to the index\&.
774 \fBgit-checkout-index\fR(1)
775 .RS 4
776 Copy files from the index to the working tree\&.
779 \fBgit-commit-graph\fR(1)
780 .RS 4
781 Write and verify Git commit\-graph files\&.
784 \fBgit-commit-tree\fR(1)
785 .RS 4
786 Create a new commit object\&.
789 \fBgit-hash-object\fR(1)
790 .RS 4
791 Compute object ID and optionally creates a blob from a file\&.
794 \fBgit-index-pack\fR(1)
795 .RS 4
796 Build pack index file for an existing packed archive\&.
799 \fBgit-merge-file\fR(1)
800 .RS 4
801 Run a three\-way file merge\&.
804 \fBgit-merge-index\fR(1)
805 .RS 4
806 Run a merge for files needing merging\&.
809 \fBgit-mktag\fR(1)
810 .RS 4
811 Creates a tag object with extra validation\&.
814 \fBgit-mktree\fR(1)
815 .RS 4
816 Build a tree\-object from ls\-tree formatted text\&.
819 \fBgit-multi-pack-index\fR(1)
820 .RS 4
821 Write and verify multi\-pack\-indexes\&.
824 \fBgit-pack-objects\fR(1)
825 .RS 4
826 Create a packed archive of objects\&.
829 \fBgit-prune-packed\fR(1)
830 .RS 4
831 Remove extra objects that are already in pack files\&.
834 \fBgit-read-tree\fR(1)
835 .RS 4
836 Reads tree information into the index\&.
839 \fBgit-symbolic-ref\fR(1)
840 .RS 4
841 Read, modify and delete symbolic refs\&.
844 \fBgit-unpack-objects\fR(1)
845 .RS 4
846 Unpack objects from a packed archive\&.
849 \fBgit-update-index\fR(1)
850 .RS 4
851 Register file contents in the working tree to the index\&.
854 \fBgit-update-ref\fR(1)
855 .RS 4
856 Update the object name stored in a ref safely\&.
859 \fBgit-write-tree\fR(1)
860 .RS 4
861 Create a tree object from the current index\&.
863 .SS "Interrogation commands"
865 \fBgit-cat-file\fR(1)
866 .RS 4
867 Provide content or type and size information for repository objects\&.
870 \fBgit-cherry\fR(1)
871 .RS 4
872 Find commits yet to be applied to upstream\&.
875 \fBgit-diff-files\fR(1)
876 .RS 4
877 Compares files in the working tree and the index\&.
880 \fBgit-diff-index\fR(1)
881 .RS 4
882 Compare a tree to the working tree or index\&.
885 \fBgit-diff-tree\fR(1)
886 .RS 4
887 Compares the content and mode of blobs found via two tree objects\&.
890 \fBgit-for-each-ref\fR(1)
891 .RS 4
892 Output information on each ref\&.
895 \fBgit-for-each-repo\fR(1)
896 .RS 4
897 Run a Git command on a list of repositories\&.
900 \fBgit-get-tar-commit-id\fR(1)
901 .RS 4
902 Extract commit ID from an archive created using git\-archive\&.
905 \fBgit-ls-files\fR(1)
906 .RS 4
907 Show information about files in the index and the working tree\&.
910 \fBgit-ls-remote\fR(1)
911 .RS 4
912 List references in a remote repository\&.
915 \fBgit-ls-tree\fR(1)
916 .RS 4
917 List the contents of a tree object\&.
920 \fBgit-merge-base\fR(1)
921 .RS 4
922 Find as good common ancestors as possible for a merge\&.
925 \fBgit-name-rev\fR(1)
926 .RS 4
927 Find symbolic names for given revs\&.
930 \fBgit-pack-redundant\fR(1)
931 .RS 4
932 Find redundant pack files\&.
935 \fBgit-rev-list\fR(1)
936 .RS 4
937 Lists commit objects in reverse chronological order\&.
940 \fBgit-rev-parse\fR(1)
941 .RS 4
942 Pick out and massage parameters\&.
945 \fBgit-show-index\fR(1)
946 .RS 4
947 Show packed archive index\&.
950 \fBgit-show-ref\fR(1)
951 .RS 4
952 List references in a local repository\&.
955 \fBgit-unpack-file\fR(1)
956 .RS 4
957 Creates a temporary file with a blob\(cqs contents\&.
960 \fBgit-var\fR(1)
961 .RS 4
962 Show a Git logical variable\&.
965 \fBgit-verify-pack\fR(1)
966 .RS 4
967 Validate packed Git archive files\&.
970 In general, the interrogate commands do not touch the files in the working tree\&.
971 .SS "Syncing repositories"
973 \fBgit-daemon\fR(1)
974 .RS 4
975 A really simple server for Git repositories\&.
978 \fBgit-fetch-pack\fR(1)
979 .RS 4
980 Receive missing objects from another repository\&.
983 \fBgit-http-backend\fR(1)
984 .RS 4
985 Server side implementation of Git over HTTP\&.
988 \fBgit-send-pack\fR(1)
989 .RS 4
990 Push objects over Git protocol to another repository\&.
993 \fBgit-update-server-info\fR(1)
994 .RS 4
995 Update auxiliary info file to help dumb servers\&.
998 The following are helper commands used by the above; end users typically do not use them directly\&.
1000 \fBgit-http-fetch\fR(1)
1001 .RS 4
1002 Download from a remote Git repository via HTTP\&.
1005 \fBgit-http-push\fR(1)
1006 .RS 4
1007 Push objects over HTTP/DAV to another repository\&.
1010 \fBgit-receive-pack\fR(1)
1011 .RS 4
1012 Receive what is pushed into the repository\&.
1015 \fBgit-shell\fR(1)
1016 .RS 4
1017 Restricted login shell for Git\-only SSH access\&.
1020 \fBgit-upload-archive\fR(1)
1021 .RS 4
1022 Send archive back to git\-archive\&.
1025 \fBgit-upload-pack\fR(1)
1026 .RS 4
1027 Send objects packed back to git\-fetch\-pack\&.
1029 .SS "Internal helper commands"
1031 These are internal helper commands used by other commands; end users typically do not use them directly\&.
1033 \fBgit-check-attr\fR(1)
1034 .RS 4
1035 Display gitattributes information\&.
1038 \fBgit-check-ignore\fR(1)
1039 .RS 4
1040 Debug gitignore / exclude files\&.
1043 \fBgit-check-mailmap\fR(1)
1044 .RS 4
1045 Show canonical names and email addresses of contacts\&.
1048 \fBgit-check-ref-format\fR(1)
1049 .RS 4
1050 Ensures that a reference name is well formed\&.
1053 \fBgit-column\fR(1)
1054 .RS 4
1055 Display data in columns\&.
1058 \fBgit-credential\fR(1)
1059 .RS 4
1060 Retrieve and store user credentials\&.
1063 \fBgit-credential-cache\fR(1)
1064 .RS 4
1065 Helper to temporarily store passwords in memory\&.
1068 \fBgit-credential-store\fR(1)
1069 .RS 4
1070 Helper to store credentials on disk\&.
1073 \fBgit-fmt-merge-msg\fR(1)
1074 .RS 4
1075 Produce a merge commit message\&.
1078 \fBgit-interpret-trailers\fR(1)
1079 .RS 4
1080 Add or parse structured information in commit messages\&.
1083 \fBgit-mailinfo\fR(1)
1084 .RS 4
1085 Extracts patch and authorship from a single e\-mail message\&.
1088 \fBgit-mailsplit\fR(1)
1089 .RS 4
1090 Simple UNIX mbox splitter program\&.
1093 \fBgit-merge-one-file\fR(1)
1094 .RS 4
1095 The standard helper program to use with git\-merge\-index\&.
1098 \fBgit-patch-id\fR(1)
1099 .RS 4
1100 Compute unique ID for a patch\&.
1103 \fBgit-sh-i18n\fR(1)
1104 .RS 4
1105 Git\(cqs i18n setup code for shell scripts\&.
1108 \fBgit-sh-setup\fR(1)
1109 .RS 4
1110 Common Git shell script setup code\&.
1113 \fBgit-stripspace\fR(1)
1114 .RS 4
1115 Remove unnecessary whitespace\&.
1117 .SH "GUIDES"
1119 The following documentation pages are guides about Git concepts\&.
1121 \fBgitattributes\fR(5)
1122 .RS 4
1123 Defining attributes per path\&.
1126 \fBgitcli\fR(7)
1127 .RS 4
1128 Git command\-line interface and conventions\&.
1131 \fBgitcore-tutorial\fR(7)
1132 .RS 4
1133 A Git core tutorial for developers\&.
1136 \fBgitcredentials\fR(7)
1137 .RS 4
1138 Providing usernames and passwords to Git\&.
1141 \fBgitcvs-migration\fR(7)
1142 .RS 4
1143 Git for CVS users\&.
1146 \fBgitdiffcore\fR(7)
1147 .RS 4
1148 Tweaking diff output\&.
1151 \fBgiteveryday\fR(7)
1152 .RS 4
1153 A useful minimum set of commands for Everyday Git\&.
1156 \fBgitfaq\fR(7)
1157 .RS 4
1158 Frequently asked questions about using Git\&.
1161 \fBgitglossary\fR(7)
1162 .RS 4
1163 A Git Glossary\&.
1166 \fBgithooks\fR(5)
1167 .RS 4
1168 Hooks used by Git\&.
1171 \fBgitignore\fR(5)
1172 .RS 4
1173 Specifies intentionally untracked files to ignore\&.
1176 \fBgitmailmap\fR(5)
1177 .RS 4
1178 Map author/committer names and/or E\-Mail addresses\&.
1181 \fBgitmodules\fR(5)
1182 .RS 4
1183 Defining submodule properties\&.
1186 \fBgitnamespaces\fR(7)
1187 .RS 4
1188 Git namespaces\&.
1191 \fBgitremote-helpers\fR(7)
1192 .RS 4
1193 Helper programs to interact with remote repositories\&.
1196 \fBgitrepository-layout\fR(5)
1197 .RS 4
1198 Git Repository Layout\&.
1201 \fBgitrevisions\fR(7)
1202 .RS 4
1203 Specifying revisions and ranges for Git\&.
1206 \fBgitsubmodules\fR(7)
1207 .RS 4
1208 Mounting one repository inside another\&.
1211 \fBgittutorial\fR(7)
1212 .RS 4
1213 A tutorial introduction to Git\&.
1216 \fBgittutorial-2\fR(7)
1217 .RS 4
1218 A tutorial introduction to Git: part two\&.
1221 \fBgitworkflows\fR(7)
1222 .RS 4
1223 An overview of recommended workflows with Git\&.
1225 .SH "CONFIGURATION MECHANISM"
1227 Git uses a simple text format to store customizations that are per repository and are per user\&. Such a configuration file may look like this:
1229 .if n \{\
1230 .RS 4
1234 # A \(aq#\(aq or \(aq;\(aq character indicates a comment\&.
1237 ; core variables
1238 [core]
1239         ; Don\(aqt trust file modes
1240         filemode = false
1242 ; user identity
1243 [user]
1244         name = "Junio C Hamano"
1245         email = "gitster@pobox\&.com"
1247 .if n \{\
1252 Various commands read from the configuration file and adjust their operation accordingly\&. See \fBgit-config\fR(1) for a list and more details about the configuration mechanism\&.
1253 .SH "IDENTIFIER TERMINOLOGY"
1255 <object>
1256 .RS 4
1257 Indicates the object name for any type of object\&.
1260 <blob>
1261 .RS 4
1262 Indicates a blob object name\&.
1265 <tree>
1266 .RS 4
1267 Indicates a tree object name\&.
1270 <commit>
1271 .RS 4
1272 Indicates a commit object name\&.
1275 <tree\-ish>
1276 .RS 4
1277 Indicates a tree, commit or tag object name\&. A command that takes a <tree\-ish> argument ultimately wants to operate on a <tree> object but automatically dereferences <commit> and <tag> objects that point at a <tree>\&.
1280 <commit\-ish>
1281 .RS 4
1282 Indicates a commit or tag object name\&. A command that takes a <commit\-ish> argument ultimately wants to operate on a <commit> object but automatically dereferences <tag> objects that point at a <commit>\&.
1285 <type>
1286 .RS 4
1287 Indicates that an object type is required\&. Currently one of:
1288 \fBblob\fR,
1289 \fBtree\fR,
1290 \fBcommit\fR, or
1291 \fBtag\fR\&.
1294 <file>
1295 .RS 4
1296 Indicates a filename \- almost always relative to the root of the tree structure
1297 \fBGIT_INDEX_FILE\fR
1298 describes\&.
1300 .SH "SYMBOLIC IDENTIFIERS"
1302 Any Git command accepting any <object> can also use the following symbolic notation:
1304 HEAD
1305 .RS 4
1306 indicates the head of the current branch\&.
1309 <tag>
1310 .RS 4
1311 a valid tag
1312 \fIname\fR
1313 (i\&.e\&. a
1314 \fBrefs/tags/<tag>\fR
1315 reference)\&.
1318 <head>
1319 .RS 4
1320 a valid head
1321 \fIname\fR
1322 (i\&.e\&. a
1323 \fBrefs/heads/<head>\fR
1324 reference)\&.
1327 For a more complete list of ways to spell object names, see "SPECIFYING REVISIONS" section in \fBgitrevisions\fR(7)\&.
1328 .SH "FILE/DIRECTORY STRUCTURE"
1330 Please see the \fBgitrepository-layout\fR(5) document\&.
1332 Read \fBgithooks\fR(5) for more details about each hook\&.
1334 Higher level SCMs may provide and manage additional information in the \fB$GIT_DIR\fR\&.
1335 .SH "TERMINOLOGY"
1337 Please see \fBgitglossary\fR(7)\&.
1338 .SH "ENVIRONMENT VARIABLES"
1340 Various Git commands use the following environment variables:
1341 .SS "The Git Repository"
1343 These environment variables apply to \fIall\fR core Git commands\&. Nb: it is worth noting that they may be used/overridden by SCMS sitting above Git so take care if using a foreign front\-end\&.
1345 \fBGIT_INDEX_FILE\fR
1346 .RS 4
1347 This environment allows the specification of an alternate index file\&. If not specified, the default of
1348 \fB$GIT_DIR/index\fR
1349 is used\&.
1352 \fBGIT_INDEX_VERSION\fR
1353 .RS 4
1354 This environment variable allows the specification of an index version for new repositories\&. It won\(cqt affect existing index files\&. By default index file version 2 or 3 is used\&. See
1355 \fBgit-update-index\fR(1)
1356 for more information\&.
1359 \fBGIT_OBJECT_DIRECTORY\fR
1360 .RS 4
1361 If the object storage directory is specified via this environment variable then the sha1 directories are created underneath \- otherwise the default
1362 \fB$GIT_DIR/objects\fR
1363 directory is used\&.
1366 \fBGIT_ALTERNATE_OBJECT_DIRECTORIES\fR
1367 .RS 4
1368 Due to the immutable nature of Git objects, old objects can be archived into shared, read\-only directories\&. This variable specifies a ":" separated (on Windows ";" separated) list of Git object directories which can be used to search for Git objects\&. New objects will not be written to these directories\&.
1370 Entries that begin with
1371 \fB"\fR
1372 (double\-quote) will be interpreted as C\-style quoted paths, removing leading and trailing double\-quotes and respecting backslash escapes\&. E\&.g\&., the value
1373 \fB"path\-with\-\e"\-and\-:\-in\-it":vanilla\-path\fR
1374 has two paths:
1375 \fBpath\-with\-"\-and\-:\-in\-it\fR
1377 \fBvanilla\-path\fR\&.
1380 \fBGIT_DIR\fR
1381 .RS 4
1382 If the
1383 \fBGIT_DIR\fR
1384 environment variable is set then it specifies a path to use instead of the default
1385 \fB\&.git\fR
1386 for the base of the repository\&. The
1387 \fB\-\-git\-dir\fR
1388 command\-line option also sets this value\&.
1391 \fBGIT_WORK_TREE\fR
1392 .RS 4
1393 Set the path to the root of the working tree\&. This can also be controlled by the
1394 \fB\-\-work\-tree\fR
1395 command\-line option and the core\&.worktree configuration variable\&.
1398 \fBGIT_NAMESPACE\fR
1399 .RS 4
1400 Set the Git namespace; see
1401 \fBgitnamespaces\fR(7)
1402 for details\&. The
1403 \fB\-\-namespace\fR
1404 command\-line option also sets this value\&.
1407 \fBGIT_CEILING_DIRECTORIES\fR
1408 .RS 4
1409 This should be a colon\-separated list of absolute paths\&. If set, it is a list of directories that Git should not chdir up into while looking for a repository directory (useful for excluding slow\-loading network directories)\&. It will not exclude the current working directory or a GIT_DIR set on the command line or in the environment\&. Normally, Git has to read the entries in this list and resolve any symlink that might be present in order to compare them with the current directory\&. However, if even this access is slow, you can add an empty entry to the list to tell Git that the subsequent entries are not symlinks and needn\(cqt be resolved; e\&.g\&.,
1410 \fBGIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink\fR\&.
1413 \fBGIT_DISCOVERY_ACROSS_FILESYSTEM\fR
1414 .RS 4
1415 When run in a directory that does not have "\&.git" repository directory, Git tries to find such a directory in the parent directories to find the top of the working tree, but by default it does not cross filesystem boundaries\&. This environment variable can be set to true to tell Git not to stop at filesystem boundaries\&. Like
1416 \fBGIT_CEILING_DIRECTORIES\fR, this will not affect an explicit repository directory set via
1417 \fBGIT_DIR\fR
1418 or on the command line\&.
1421 \fBGIT_COMMON_DIR\fR
1422 .RS 4
1423 If this variable is set to a path, non\-worktree files that are normally in $GIT_DIR will be taken from this path instead\&. Worktree\-specific files such as HEAD or index are taken from $GIT_DIR\&. See
1424 \fBgitrepository-layout\fR(5)
1426 \fBgit-worktree\fR(1)
1427 for details\&. This variable has lower precedence than other path variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY\&...
1430 \fBGIT_DEFAULT_HASH\fR
1431 .RS 4
1432 If this variable is set, the default hash algorithm for new repositories will be set to this value\&. This value is currently ignored when cloning; the setting of the remote repository is used instead\&. The default is "sha1"\&. THIS VARIABLE IS EXPERIMENTAL! See
1433 \fB\-\-object\-format\fR
1435 \fBgit-init\fR(1)\&.
1437 .SS "Git Commits"
1439 \fBGIT_AUTHOR_NAME\fR
1440 .RS 4
1441 The human\-readable name used in the author identity when creating commit or tag objects, or when writing reflogs\&. Overrides the
1442 \fBuser\&.name\fR
1444 \fBauthor\&.name\fR
1445 configuration settings\&.
1448 \fBGIT_AUTHOR_EMAIL\fR
1449 .RS 4
1450 The email address used in the author identity when creating commit or tag objects, or when writing reflogs\&. Overrides the
1451 \fBuser\&.email\fR
1453 \fBauthor\&.email\fR
1454 configuration settings\&.
1457 \fBGIT_AUTHOR_DATE\fR
1458 .RS 4
1459 The date used for the author identity when creating commit or tag objects, or when writing reflogs\&. See
1460 \fBgit-commit\fR(1)
1461 for valid formats\&.
1464 \fBGIT_COMMITTER_NAME\fR
1465 .RS 4
1466 The human\-readable name used in the committer identity when creating commit or tag objects, or when writing reflogs\&. Overrides the
1467 \fBuser\&.name\fR
1469 \fBcommitter\&.name\fR
1470 configuration settings\&.
1473 \fBGIT_COMMITTER_EMAIL\fR
1474 .RS 4
1475 The email address used in the author identity when creating commit or tag objects, or when writing reflogs\&. Overrides the
1476 \fBuser\&.email\fR
1478 \fBcommitter\&.email\fR
1479 configuration settings\&.
1482 \fBGIT_COMMITTER_DATE\fR
1483 .RS 4
1484 The date used for the committer identity when creating commit or tag objects, or when writing reflogs\&. See
1485 \fBgit-commit\fR(1)
1486 for valid formats\&.
1489 \fBEMAIL\fR
1490 .RS 4
1491 The email address used in the author and committer identities if no other relevant environment variable or configuration setting has been set\&.
1493 .SS "Git Diffs"
1495 \fBGIT_DIFF_OPTS\fR
1496 .RS 4
1497 Only valid setting is "\-\-unified=??" or "\-u??" to set the number of context lines shown when a unified diff is created\&. This takes precedence over any "\-U" or "\-\-unified" option value passed on the Git diff command line\&.
1500 \fBGIT_EXTERNAL_DIFF\fR
1501 .RS 4
1502 When the environment variable
1503 \fBGIT_EXTERNAL_DIFF\fR
1504 is set, the program named by it is called to generate diffs, and Git does not use its builtin diff machinery\&. For a path that is added, removed, or modified,
1505 \fBGIT_EXTERNAL_DIFF\fR
1506 is called with 7 parameters:
1508 .if n \{\
1509 .RS 4
1512 path old\-file old\-hex old\-mode new\-file new\-hex new\-mode
1514 .if n \{\
1518 where:
1521 <old|new>\-file
1522 .RS 4
1523 are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>,
1526 <old|new>\-hex
1527 .RS 4
1528 are the 40\-hexdigit SHA\-1 hashes,
1531 <old|new>\-mode
1532 .RS 4
1533 are the octal representation of the file modes\&.
1535 The file parameters can point at the user\(cqs working file (e\&.g\&.
1536 \fBnew\-file\fR
1537 in "git\-diff\-files"),
1538 \fB/dev/null\fR
1539 (e\&.g\&.
1540 \fBold\-file\fR
1541 when a new file is added), or a temporary file (e\&.g\&.
1542 \fBold\-file\fR
1543 in the index)\&.
1544 \fBGIT_EXTERNAL_DIFF\fR
1545 should not worry about unlinking the temporary file \-\-\- it is removed when
1546 \fBGIT_EXTERNAL_DIFF\fR
1547 exits\&.
1549 For a path that is unmerged,
1550 \fBGIT_EXTERNAL_DIFF\fR
1551 is called with 1 parameter, <path>\&.
1553 For each path
1554 \fBGIT_EXTERNAL_DIFF\fR
1555 is called, two environment variables,
1556 \fBGIT_DIFF_PATH_COUNTER\fR
1558 \fBGIT_DIFF_PATH_TOTAL\fR
1559 are set\&.
1562 \fBGIT_DIFF_PATH_COUNTER\fR
1563 .RS 4
1564 A 1\-based counter incremented by one for every path\&.
1567 \fBGIT_DIFF_PATH_TOTAL\fR
1568 .RS 4
1569 The total number of paths\&.
1571 .SS "other"
1573 \fBGIT_MERGE_VERBOSITY\fR
1574 .RS 4
1575 A number controlling the amount of output shown by the recursive merge strategy\&. Overrides merge\&.verbosity\&. See
1576 \fBgit-merge\fR(1)
1579 \fBGIT_PAGER\fR
1580 .RS 4
1581 This environment variable overrides
1582 \fB$PAGER\fR\&. If it is set to an empty string or to the value "cat", Git will not launch a pager\&. See also the
1583 \fBcore\&.pager\fR
1584 option in
1585 \fBgit-config\fR(1)\&.
1588 \fBGIT_PROGRESS_DELAY\fR
1589 .RS 4
1590 A number controlling how many seconds to delay before showing optional progress indicators\&. Defaults to 2\&.
1593 \fBGIT_EDITOR\fR
1594 .RS 4
1595 This environment variable overrides
1596 \fB$EDITOR\fR
1598 \fB$VISUAL\fR\&. It is used by several Git commands when, on interactive mode, an editor is to be launched\&. See also
1599 \fBgit-var\fR(1)
1600 and the
1601 \fBcore\&.editor\fR
1602 option in
1603 \fBgit-config\fR(1)\&.
1606 \fBGIT_SEQUENCE_EDITOR\fR
1607 .RS 4
1608 This environment variable overrides the configured Git editor when editing the todo list of an interactive rebase\&. See also
1609 \fBgit-rebase\fR(1)
1610 and the
1611 \fBsequence\&.editor\fR
1612 option in
1613 \fBgit-config\fR(1)\&.
1616 \fBGIT_SSH\fR, \fBGIT_SSH_COMMAND\fR
1617 .RS 4
1618 If either of these environment variables is set then
1619 \fIgit fetch\fR
1621 \fIgit push\fR
1622 will use the specified command instead of
1623 \fIssh\fR
1624 when they need to connect to a remote system\&. The command\-line parameters passed to the configured command are determined by the ssh variant\&. See
1625 \fBssh\&.variant\fR
1626 option in
1627 \fBgit-config\fR(1)
1628 for details\&.
1630 \fB$GIT_SSH_COMMAND\fR
1631 takes precedence over
1632 \fB$GIT_SSH\fR, and is interpreted by the shell, which allows additional arguments to be included\&.
1633 \fB$GIT_SSH\fR
1634 on the other hand must be just the path to a program (which can be a wrapper shell script, if additional arguments are needed)\&.
1636 Usually it is easier to configure any desired options through your personal
1637 \fB\&.ssh/config\fR
1638 file\&. Please consult your ssh documentation for further details\&.
1641 \fBGIT_SSH_VARIANT\fR
1642 .RS 4
1643 If this environment variable is set, it overrides Git\(cqs autodetection whether
1644 \fBGIT_SSH\fR/\fBGIT_SSH_COMMAND\fR/\fBcore\&.sshCommand\fR
1645 refer to OpenSSH, plink or tortoiseplink\&. This variable overrides the config setting
1646 \fBssh\&.variant\fR
1647 that serves the same purpose\&.
1650 \fBGIT_ASKPASS\fR
1651 .RS 4
1652 If this environment variable is set, then Git commands which need to acquire passwords or passphrases (e\&.g\&. for HTTP or IMAP authentication) will call this program with a suitable prompt as command\-line argument and read the password from its STDOUT\&. See also the
1653 \fBcore\&.askPass\fR
1654 option in
1655 \fBgit-config\fR(1)\&.
1658 \fBGIT_TERMINAL_PROMPT\fR
1659 .RS 4
1660 If this environment variable is set to
1661 \fB0\fR, git will not prompt on the terminal (e\&.g\&., when asking for HTTP authentication)\&.
1664 \fBGIT_CONFIG_GLOBAL\fR, \fBGIT_CONFIG_SYSTEM\fR
1665 .RS 4
1666 Take the configuration from the given files instead from global or system\-level configuration files\&. If
1667 \fBGIT_CONFIG_SYSTEM\fR
1668 is set, the system config file defined at build time (usually
1669 \fB/etc/gitconfig\fR) will not be read\&. Likewise, if
1670 \fBGIT_CONFIG_GLOBAL\fR
1671 is set, neither
1672 \fB$HOME/\&.gitconfig\fR
1674 \fB$XDG_CONFIG_HOME/git/config\fR
1675 will be read\&. Can be set to
1676 \fB/dev/null\fR
1677 to skip reading configuration files of the respective level\&.
1680 \fBGIT_CONFIG_NOSYSTEM\fR
1681 .RS 4
1682 Whether to skip reading settings from the system\-wide
1683 \fB$(prefix)/etc/gitconfig\fR
1684 file\&. This environment variable can be used along with
1685 \fB$HOME\fR
1687 \fB$XDG_CONFIG_HOME\fR
1688 to create a predictable environment for a picky script, or you can set it temporarily to avoid using a buggy
1689 \fB/etc/gitconfig\fR
1690 file while waiting for someone with sufficient permissions to fix it\&.
1693 \fBGIT_FLUSH\fR
1694 .RS 4
1695 If this environment variable is set to "1", then commands such as
1696 \fIgit blame\fR
1697 (in incremental mode),
1698 \fIgit rev\-list\fR,
1699 \fIgit log\fR,
1700 \fIgit check\-attr\fR
1702 \fIgit check\-ignore\fR
1703 will force a flush of the output stream after each record have been flushed\&. If this variable is set to "0", the output of these commands will be done using completely buffered I/O\&. If this environment variable is not set, Git will choose buffered or record\-oriented flushing based on whether stdout appears to be redirected to a file or not\&.
1706 \fBGIT_TRACE\fR
1707 .RS 4
1708 Enables general trace messages, e\&.g\&. alias expansion, built\-in command execution and external command execution\&.
1710 If this variable is set to "1", "2" or "true" (comparison is case insensitive), trace messages will be printed to stderr\&.
1712 If the variable is set to an integer value greater than 2 and lower than 10 (strictly) then Git will interpret this value as an open file descriptor and will try to write the trace messages into this file descriptor\&.
1714 Alternatively, if the variable is set to an absolute path (starting with a
1715 \fI/\fR
1716 character), Git will interpret this as a file path and will try to append the trace messages to it\&.
1718 Unsetting the variable, or setting it to empty, "0" or "false" (case insensitive) disables trace messages\&.
1721 \fBGIT_TRACE_FSMONITOR\fR
1722 .RS 4
1723 Enables trace messages for the filesystem monitor extension\&. See
1724 \fBGIT_TRACE\fR
1725 for available trace output options\&.
1728 \fBGIT_TRACE_PACK_ACCESS\fR
1729 .RS 4
1730 Enables trace messages for all accesses to any packs\&. For each access, the pack file name and an offset in the pack is recorded\&. This may be helpful for troubleshooting some pack\-related performance problems\&. See
1731 \fBGIT_TRACE\fR
1732 for available trace output options\&.
1735 \fBGIT_TRACE_PACKET\fR
1736 .RS 4
1737 Enables trace messages for all packets coming in or out of a given program\&. This can help with debugging object negotiation or other protocol issues\&. Tracing is turned off at a packet starting with "PACK" (but see
1738 \fBGIT_TRACE_PACKFILE\fR
1739 below)\&. See
1740 \fBGIT_TRACE\fR
1741 for available trace output options\&.
1744 \fBGIT_TRACE_PACKFILE\fR
1745 .RS 4
1746 Enables tracing of packfiles sent or received by a given program\&. Unlike other trace output, this trace is verbatim: no headers, and no quoting of binary data\&. You almost certainly want to direct into a file (e\&.g\&.,
1747 \fBGIT_TRACE_PACKFILE=/tmp/my\&.pack\fR) rather than displaying it on the terminal or mixing it with other trace output\&.
1749 Note that this is currently only implemented for the client side of clones and fetches\&.
1752 \fBGIT_TRACE_PERFORMANCE\fR
1753 .RS 4
1754 Enables performance related trace messages, e\&.g\&. total execution time of each Git command\&. See
1755 \fBGIT_TRACE\fR
1756 for available trace output options\&.
1759 \fBGIT_TRACE_REFS\fR
1760 .RS 4
1761 Enables trace messages for operations on the ref database\&. See
1762 \fBGIT_TRACE\fR
1763 for available trace output options\&.
1766 \fBGIT_TRACE_SETUP\fR
1767 .RS 4
1768 Enables trace messages printing the \&.git, working tree and current working directory after Git has completed its setup phase\&. See
1769 \fBGIT_TRACE\fR
1770 for available trace output options\&.
1773 \fBGIT_TRACE_SHALLOW\fR
1774 .RS 4
1775 Enables trace messages that can help debugging fetching / cloning of shallow repositories\&. See
1776 \fBGIT_TRACE\fR
1777 for available trace output options\&.
1780 \fBGIT_TRACE_CURL\fR
1781 .RS 4
1782 Enables a curl full trace dump of all incoming and outgoing data, including descriptive information, of the git transport protocol\&. This is similar to doing curl
1783 \fB\-\-trace\-ascii\fR
1784 on the command line\&. See
1785 \fBGIT_TRACE\fR
1786 for available trace output options\&.
1789 \fBGIT_TRACE_CURL_NO_DATA\fR
1790 .RS 4
1791 When a curl trace is enabled (see
1792 \fBGIT_TRACE_CURL\fR
1793 above), do not dump data (that is, only dump info lines and headers)\&.
1796 \fBGIT_TRACE2\fR
1797 .RS 4
1798 Enables more detailed trace messages from the "trace2" library\&. Output from
1799 \fBGIT_TRACE2\fR
1800 is a simple text\-based format for human readability\&.
1802 If this variable is set to "1", "2" or "true" (comparison is case insensitive), trace messages will be printed to stderr\&.
1804 If the variable is set to an integer value greater than 2 and lower than 10 (strictly) then Git will interpret this value as an open file descriptor and will try to write the trace messages into this file descriptor\&.
1806 Alternatively, if the variable is set to an absolute path (starting with a
1807 \fI/\fR
1808 character), Git will interpret this as a file path and will try to append the trace messages to it\&. If the path already exists and is a directory, the trace messages will be written to files (one per process) in that directory, named according to the last component of the SID and an optional counter (to avoid filename collisions)\&.
1810 In addition, if the variable is set to
1811 \fBaf_unix:[<socket_type>:]<absolute\-pathname>\fR, Git will try to open the path as a Unix Domain Socket\&. The socket type can be either
1812 \fBstream\fR
1814 \fBdgram\fR\&.
1816 Unsetting the variable, or setting it to empty, "0" or "false" (case insensitive) disables trace messages\&.
1819 \m[blue]\fBTrace2 documentation\fR\m[]\&\s-2\u[2]\d\s+2
1820 for full details\&.
1823 \fBGIT_TRACE2_EVENT\fR
1824 .RS 4
1825 This setting writes a JSON\-based format that is suited for machine interpretation\&. See
1826 \fBGIT_TRACE2\fR
1827 for available trace output options and
1828 \m[blue]\fBTrace2 documentation\fR\m[]\&\s-2\u[2]\d\s+2
1829 for full details\&.
1832 \fBGIT_TRACE2_PERF\fR
1833 .RS 4
1834 In addition to the text\-based messages available in
1835 \fBGIT_TRACE2\fR, this setting writes a column\-based format for understanding nesting regions\&. See
1836 \fBGIT_TRACE2\fR
1837 for available trace output options and
1838 \m[blue]\fBTrace2 documentation\fR\m[]\&\s-2\u[2]\d\s+2
1839 for full details\&.
1842 \fBGIT_TRACE_REDACT\fR
1843 .RS 4
1844 By default, when tracing is activated, Git redacts the values of cookies, the "Authorization:" header, the "Proxy\-Authorization:" header and packfile URIs\&. Set this variable to
1845 \fB0\fR
1846 to prevent this redaction\&.
1849 \fBGIT_LITERAL_PATHSPECS\fR
1850 .RS 4
1851 Setting this variable to
1852 \fB1\fR
1853 will cause Git to treat all pathspecs literally, rather than as glob patterns\&. For example, running
1854 \fBGIT_LITERAL_PATHSPECS=1 git log \-\- \(aq*\&.c\(aq\fR
1855 will search for commits that touch the path
1856 \fB*\&.c\fR, not any paths that the glob
1857 \fB*\&.c\fR
1858 matches\&. You might want this if you are feeding literal paths to Git (e\&.g\&., paths previously given to you by
1859 \fBgit ls\-tree\fR,
1860 \fB\-\-raw\fR
1861 diff output, etc)\&.
1864 \fBGIT_GLOB_PATHSPECS\fR
1865 .RS 4
1866 Setting this variable to
1867 \fB1\fR
1868 will cause Git to treat all pathspecs as glob patterns (aka "glob" magic)\&.
1871 \fBGIT_NOGLOB_PATHSPECS\fR
1872 .RS 4
1873 Setting this variable to
1874 \fB1\fR
1875 will cause Git to treat all pathspecs as literal (aka "literal" magic)\&.
1878 \fBGIT_ICASE_PATHSPECS\fR
1879 .RS 4
1880 Setting this variable to
1881 \fB1\fR
1882 will cause Git to treat all pathspecs as case\-insensitive\&.
1885 \fBGIT_REFLOG_ACTION\fR
1886 .RS 4
1887 When a ref is updated, reflog entries are created to keep track of the reason why the ref was updated (which is typically the name of the high\-level command that updated the ref), in addition to the old and new values of the ref\&. A scripted Porcelain command can use set_reflog_action helper function in
1888 \fBgit\-sh\-setup\fR
1889 to set its name to this variable when it is invoked as the top level command by the end user, to be recorded in the body of the reflog\&.
1892 \fBGIT_REF_PARANOIA\fR
1893 .RS 4
1894 If set to
1895 \fB0\fR, ignore broken or badly named refs when iterating over lists of refs\&. Normally Git will try to include any such refs, which may cause some operations to fail\&. This is usually preferable, as potentially destructive operations (e\&.g\&.,
1896 \fBgit-prune\fR(1)) are better off aborting rather than ignoring broken refs (and thus considering the history they point to as not worth saving)\&. The default value is
1897 \fB1\fR
1898 (i\&.e\&., be paranoid about detecting and aborting all operations)\&. You should not normally need to set this to
1899 \fB0\fR, but it may be useful when trying to salvage data from a corrupted repository\&.
1902 \fBGIT_ALLOW_PROTOCOL\fR
1903 .RS 4
1904 If set to a colon\-separated list of protocols, behave as if
1905 \fBprotocol\&.allow\fR
1906 is set to
1907 \fBnever\fR, and each of the listed protocols has
1908 \fBprotocol\&.<name>\&.allow\fR
1909 set to
1910 \fBalways\fR
1911 (overriding any existing configuration)\&. In other words, any protocol not mentioned will be disallowed (i\&.e\&., this is a whitelist, not a blacklist)\&. See the description of
1912 \fBprotocol\&.allow\fR
1914 \fBgit-config\fR(1)
1915 for more details\&.
1918 \fBGIT_PROTOCOL_FROM_USER\fR
1919 .RS 4
1920 Set to 0 to prevent protocols used by fetch/push/clone which are configured to the
1921 \fBuser\fR
1922 state\&. This is useful to restrict recursive submodule initialization from an untrusted repository or for programs which feed potentially\-untrusted URLS to git commands\&. See
1923 \fBgit-config\fR(1)
1924 for more details\&.
1927 \fBGIT_PROTOCOL\fR
1928 .RS 4
1929 For internal use only\&. Used in handshaking the wire protocol\&. Contains a colon
1930 \fI:\fR
1931 separated list of keys with optional values
1932 \fIkey[=value]\fR\&. Presence of unknown keys and values must be ignored\&.
1934 Note that servers may need to be configured to allow this variable to pass over some transports\&. It will be propagated automatically when accessing local repositories (i\&.e\&.,
1935 \fBfile://\fR
1936 or a filesystem path), as well as over the
1937 \fBgit://\fR
1938 protocol\&. For git\-over\-http, it should work automatically in most configurations, but see the discussion in
1939 \fBgit-http-backend\fR(1)\&. For git\-over\-ssh, the ssh server may need to be configured to allow clients to pass this variable (e\&.g\&., by using
1940 \fBAcceptEnv GIT_PROTOCOL\fR
1941 with OpenSSH)\&.
1943 This configuration is optional\&. If the variable is not propagated, then clients will fall back to the original "v0" protocol (but may miss out on some performance improvements or features)\&. This variable currently only affects clones and fetches; it is not yet used for pushes (but may be in the future)\&.
1946 \fBGIT_OPTIONAL_LOCKS\fR
1947 .RS 4
1948 If set to
1949 \fB0\fR, Git will complete any requested operation without performing any optional sub\-operations that require taking a lock\&. For example, this will prevent
1950 \fBgit status\fR
1951 from refreshing the index as a side effect\&. This is useful for processes running in the background which do not want to cause lock contention with other operations on the repository\&. Defaults to
1952 \fB1\fR\&.
1955 \fBGIT_REDIRECT_STDIN\fR, \fBGIT_REDIRECT_STDOUT\fR, \fBGIT_REDIRECT_STDERR\fR
1956 .RS 4
1957 Windows\-only: allow redirecting the standard input/output/error handles to paths specified by the environment variables\&. This is particularly useful in multi\-threaded applications where the canonical way to pass standard handles via
1958 \fBCreateProcess()\fR
1959 is not an option because it would require the handles to be marked inheritable (and consequently
1960 \fBevery\fR
1961 spawned process would inherit them, possibly blocking regular Git operations)\&. The primary intended use case is to use named pipes for communication (e\&.g\&.
1962 \fB\e\e\&.\epipe\emy\-git\-stdin\-123\fR)\&.
1964 Two special values are supported:
1965 \fBoff\fR
1966 will simply close the corresponding standard handle, and if
1967 \fBGIT_REDIRECT_STDERR\fR
1969 \fB2>&1\fR, standard error will be redirected to the same handle as standard output\&.
1972 \fBGIT_PRINT_SHA1_ELLIPSIS\fR (deprecated)
1973 .RS 4
1974 If set to
1975 \fByes\fR, print an ellipsis following an (abbreviated) SHA\-1 value\&. This affects indications of detached HEADs (\fBgit-checkout\fR(1)) and the raw diff output (\fBgit-diff\fR(1))\&. Printing an ellipsis in the cases mentioned is no longer considered adequate and support for it is likely to be removed in the foreseeable future (along with the variable)\&.
1977 .SH "DISCUSSION"
1979 More detail on the following is available from the \m[blue]\fBGit concepts chapter of the user\-manual\fR\m[]\&\s-2\u[3]\d\s+2 and \fBgitcore-tutorial\fR(7)\&.
1981 A Git project normally consists of a working directory with a "\&.git" subdirectory at the top level\&. The \&.git directory contains, among other things, a compressed object database representing the complete history of the project, an "index" file which links that history to the current contents of the working tree, and named pointers into that history such as tags and branch heads\&.
1983 The object database contains objects of three main types: blobs, which hold file data; trees, which point to blobs and other trees to build up directory hierarchies; and commits, which each reference a single tree and some number of parent commits\&.
1985 The commit, equivalent to what other systems call a "changeset" or "version", represents a step in the project\(cqs history, and each parent represents an immediately preceding step\&. Commits with more than one parent represent merges of independent lines of development\&.
1987 All objects are named by the SHA\-1 hash of their contents, normally written as a string of 40 hex digits\&. Such names are globally unique\&. The entire history leading up to a commit can be vouched for by signing just that commit\&. A fourth object type, the tag, is provided for this purpose\&.
1989 When first created, objects are stored in individual files, but for efficiency may later be compressed together into "pack files"\&.
1991 Named pointers called refs mark interesting points in history\&. A ref may contain the SHA\-1 name of an object or the name of another ref\&. Refs with names beginning \fBref/head/\fR contain the SHA\-1 name of the most recent commit (or "head") of a branch under development\&. SHA\-1 names of tags of interest are stored under \fBref/tags/\fR\&. A special ref named \fBHEAD\fR contains the name of the currently checked\-out branch\&.
1993 The index file is initialized with a list of all paths and, for each path, a blob object and a set of attributes\&. The blob object represents the contents of the file as of the head of the current branch\&. The attributes (last modified time, size, etc\&.) are taken from the corresponding file in the working tree\&. Subsequent changes to the working tree can be found by comparing these attributes\&. The index may be updated with new content, and new commits may be created from the content stored in the index\&.
1995 The index is also capable of storing multiple entries (called "stages") for a given pathname\&. These stages are used to hold the various unmerged version of a file when a merge is in progress\&.
1996 .SH "FURTHER DOCUMENTATION"
1998 See the references in the "description" section to get started using Git\&. The following is probably more detail than necessary for a first\-time user\&.
2000 The \m[blue]\fBGit concepts chapter of the user\-manual\fR\m[]\&\s-2\u[3]\d\s+2 and \fBgitcore-tutorial\fR(7) both provide introductions to the underlying Git architecture\&.
2002 See \fBgitworkflows\fR(7) for an overview of recommended workflows\&.
2004 See also the \m[blue]\fBhowto\fR\m[]\&\s-2\u[4]\d\s+2 documents for some useful examples\&.
2006 The internals are documented in the \m[blue]\fBGit API documentation\fR\m[]\&\s-2\u[5]\d\s+2\&.
2008 Users migrating from CVS may also want to read \fBgitcvs-migration\fR(7)\&.
2009 .SH "AUTHORS"
2011 Git was started by Linus Torvalds, and is currently maintained by Junio C Hamano\&. Numerous contributions have come from the Git mailing list <\m[blue]\fBgit@vger\&.kernel\&.org\fR\m[]\&\s-2\u[6]\d\s+2>\&. \m[blue]\fBhttp://www\&.openhub\&.net/p/git/contributors/summary\fR\m[] gives you a more complete list of contributors\&.
2013 If you have a clone of git\&.git itself, the output of \fBgit-shortlog\fR(1) and \fBgit-blame\fR(1) can show you the authors for specific parts of the project\&.
2014 .SH "REPORTING BUGS"
2016 Report bugs to the Git mailing list <\m[blue]\fBgit@vger\&.kernel\&.org\fR\m[]\&\s-2\u[6]\d\s+2> where the development and maintenance is primarily done\&. You do not have to be subscribed to the list to send a message there\&. See the list archive at \m[blue]\fBhttps://lore\&.kernel\&.org/git\fR\m[] for previous bug reports and other discussions\&.
2018 Issues which are security relevant should be disclosed privately to the Git Security mailing list <\m[blue]\fBgit\-security@googlegroups\&.com\fR\m[]\&\s-2\u[7]\d\s+2>\&.
2019 .SH "SEE ALSO"
2021 \fBgittutorial\fR(7), \fBgittutorial-2\fR(7), \fBgiteveryday\fR(7), \fBgitcvs-migration\fR(7), \fBgitglossary\fR(7), \fBgitcore-tutorial\fR(7), \fBgitcli\fR(7), \m[blue]\fBThe Git User\(cqs Manual\fR\m[]\&\s-2\u[1]\d\s+2, \fBgitworkflows\fR(7)
2022 .SH "GIT"
2024 Part of the \fBgit\fR(1) suite
2025 .SH "NOTES"
2026 .IP " 1." 4
2027 Git User\(cqs Manual
2028 .RS 4
2029 \%git-htmldocs/user-manual.html
2031 .IP " 2." 4
2032 Trace2 documentation
2033 .RS 4
2034 \%git-htmldocs/technical/api-trace2.html
2036 .IP " 3." 4
2037 Git concepts chapter of the user-manual
2038 .RS 4
2039 \%git-htmldocs/user-manual.html#git-concepts
2041 .IP " 4." 4
2042 howto
2043 .RS 4
2044 \%git-htmldocs/howto-index.html
2046 .IP " 5." 4
2047 Git API documentation
2048 .RS 4
2049 \%git-htmldocs/technical/api-index.html
2051 .IP " 6." 4
2052 git@vger.kernel.org
2053 .RS 4
2054 \%mailto:git@vger.kernel.org
2056 .IP " 7." 4
2057 git-security@googlegroups.com
2058 .RS 4
2059 \%mailto:git-security@googlegroups.com