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