]>
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] |
463a849d MM |
12 | 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] |
13 | [-p|--paginate|--no-pager] | |
892c41b9 ML |
14 | [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] |
15 | [--help] COMMAND [ARGS] | |
2cf565c5 DG |
16 | |
17 | DESCRIPTION | |
18 | ----------- | |
23091e95 BF |
19 | Git is a fast, scalable, distributed revision control system with an |
20 | unusually rich command set that provides both high-level operations | |
21 | and full access to internals. | |
22 | ||
b27a23e3 | 23 | See this linkgit:gittutorial[7][tutorial] to get started, then see |
23091e95 BF |
24 | link:everyday.html[Everyday Git] for a useful minimum set of commands, and |
25 | "man git-commandname" for documentation of each command. CVS users may | |
b27a23e3 | 26 | also want to read linkgit:gitcvs-migration[7][CVS migration]. See |
a1dc34fa BF |
27 | link:user-manual.html[Git User's Manual] for a more in-depth |
28 | introduction. | |
cb22bc44 | 29 | |
4514ad4f | 30 | The COMMAND is either a name of a Git command (see below) or an alias |
5162e697 | 31 | as defined in the configuration file (see linkgit:git-config[1]). |
4514ad4f | 32 | |
34b604af JA |
33 | Formatted and hyperlinked version of the latest git |
34 | documentation can be viewed at | |
35 | `http://www.kernel.org/pub/software/scm/git/docs/`. | |
36 | ||
26cfcfbf JH |
37 | ifdef::stalenotes[] |
38 | [NOTE] | |
39 | ============ | |
26cfcfbf | 40 | |
2ff3f61a JH |
41 | You are reading the documentation for the latest (possibly |
42 | unreleased) version of git, that is available from 'master' | |
43 | branch of the `git.git` repository. | |
44 | Documentation for older releases are available here: | |
43a8e4fe | 45 | |
e636106c | 46 | * link:v1.5.6.1/git.html[documentation for release 1.5.6.1] |
e449f105 JH |
47 | |
48 | * release notes for | |
e636106c JH |
49 | link:RelNotes-1.5.6.1.txt[1.5.6.1]. |
50 | link:RelNotes-1.5.6.txt[1.5.6]. | |
e449f105 | 51 | |
e636106c | 52 | * link:v1.5.5.4/git.html[documentation for release 1.5.5.4] |
1d2375dd JH |
53 | |
54 | * release notes for | |
7064ca51 | 55 | link:RelNotes-1.5.5.4.txt[1.5.5.4], |
28bc3022 | 56 | link:RelNotes-1.5.5.3.txt[1.5.5.3], |
2d3922dc | 57 | link:RelNotes-1.5.5.2.txt[1.5.5.2], |
66aaa2fc | 58 | link:RelNotes-1.5.5.1.txt[1.5.5.1], |
1d2375dd JH |
59 | link:RelNotes-1.5.5.txt[1.5.5]. |
60 | ||
803d5158 | 61 | * link:v1.5.4.5/git.html[documentation for release 1.5.4.5] |
6ce8e44a JH |
62 | |
63 | * release notes for | |
803d5158 | 64 | link:RelNotes-1.5.4.5.txt[1.5.4.5], |
ad416ed4 | 65 | link:RelNotes-1.5.4.4.txt[1.5.4.4], |
923d44ae | 66 | link:RelNotes-1.5.4.3.txt[1.5.4.3], |
cf5c51ef | 67 | link:RelNotes-1.5.4.2.txt[1.5.4.2], |
ecb879f8 | 68 | link:RelNotes-1.5.4.1.txt[1.5.4.1], |
6ce8e44a JH |
69 | link:RelNotes-1.5.4.txt[1.5.4]. |
70 | ||
e708af6e | 71 | * link:v1.5.3.8/git.html[documentation for release 1.5.3.8] |
5587cac2 JH |
72 | |
73 | * release notes for | |
e708af6e | 74 | link:RelNotes-1.5.3.8.txt[1.5.3.8], |
b52e985a | 75 | link:RelNotes-1.5.3.7.txt[1.5.3.7], |
4a44b9ea | 76 | link:RelNotes-1.5.3.6.txt[1.5.3.6], |
afc05f9f | 77 | link:RelNotes-1.5.3.5.txt[1.5.3.5], |
58ba4f6a | 78 | link:RelNotes-1.5.3.4.txt[1.5.3.4], |
326df26d | 79 | link:RelNotes-1.5.3.3.txt[1.5.3.3], |
077d6f72 | 80 | link:RelNotes-1.5.3.2.txt[1.5.3.2], |
8d863c98 JH |
81 | link:RelNotes-1.5.3.1.txt[1.5.3.1], |
82 | link:RelNotes-1.5.3.txt[1.5.3]. | |
b6e4db6a | 83 | |
e636106c JH |
84 | * link:v1.5.2.5/git.html[documentation for release 1.5.2.5] |
85 | ||
aba170cd | 86 | * release notes for |
da899deb | 87 | link:RelNotes-1.5.2.5.txt[1.5.2.5], |
baafd6e7 | 88 | link:RelNotes-1.5.2.4.txt[1.5.2.4], |
444649e5 | 89 | link:RelNotes-1.5.2.3.txt[1.5.2.3], |
3e48af38 JH |
90 | link:RelNotes-1.5.2.2.txt[1.5.2.2], |
91 | link:RelNotes-1.5.2.1.txt[1.5.2.1], | |
aba170cd JH |
92 | link:RelNotes-1.5.2.txt[1.5.2]. |
93 | ||
94 | * link:v1.5.1.6/git.html[documentation for release 1.5.1.6] | |
95 | ||
96 | * release notes for | |
97 | link:RelNotes-1.5.1.6.txt[1.5.1.6], | |
98 | link:RelNotes-1.5.1.5.txt[1.5.1.5], | |
2ff3f61a JH |
99 | link:RelNotes-1.5.1.4.txt[1.5.1.4], |
100 | link:RelNotes-1.5.1.3.txt[1.5.1.3], | |
101 | link:RelNotes-1.5.1.2.txt[1.5.1.2], | |
102 | link:RelNotes-1.5.1.1.txt[1.5.1.1], | |
103 | link:RelNotes-1.5.1.txt[1.5.1]. | |
104 | ||
105 | * link:v1.5.0.7/git.html[documentation for release 1.5.0.7] | |
106 | ||
aba170cd JH |
107 | * release notes for |
108 | link:RelNotes-1.5.0.7.txt[1.5.0.7], | |
2ff3f61a JH |
109 | link:RelNotes-1.5.0.6.txt[1.5.0.6], |
110 | link:RelNotes-1.5.0.5.txt[1.5.0.5], | |
111 | link:RelNotes-1.5.0.3.txt[1.5.0.3], | |
112 | link:RelNotes-1.5.0.2.txt[1.5.0.2], | |
113 | link:RelNotes-1.5.0.1.txt[1.5.0.1], | |
114 | link:RelNotes-1.5.0.txt[1.5.0]. | |
115 | ||
116 | * documentation for release link:v1.4.4.4/git.html[1.4.4.4], | |
117 | link:v1.3.3/git.html[1.3.3], | |
118 | link:v1.2.6/git.html[1.2.6], | |
119 | link:v1.0.13/git.html[1.0.13]. | |
26cfcfbf JH |
120 | |
121 | ============ | |
122 | ||
123 | endif::stalenotes[] | |
124 | ||
cb22bc44 AE |
125 | OPTIONS |
126 | ------- | |
127 | --version:: | |
a87cd02c | 128 | Prints the git suite version that the 'git' program came from. |
cb22bc44 AE |
129 | |
130 | --help:: | |
a87cd02c | 131 | Prints the synopsis and a list of the most commonly used |
0f6f195b CC |
132 | commands. If the option '--all' or '-a' is given then all |
133 | available commands are printed. If a git command is named this | |
134 | option will bring up the manual page for that command. | |
45533d26 CC |
135 | + |
136 | Other options are available to control how the manual page is | |
5162e697 | 137 | displayed. See linkgit:git-help[1] for more information, |
45533d26 CC |
138 | because 'git --help ...' is converted internally into 'git |
139 | help ...'. | |
cb22bc44 AE |
140 | |
141 | --exec-path:: | |
a87cd02c | 142 | Path to wherever your core git programs are installed. |
cb22bc44 AE |
143 | This can also be controlled by setting the GIT_EXEC_PATH |
144 | environment variable. If no path is given 'git' will print | |
145 | the current setting and then exit. | |
146 | ||
3240240f SB |
147 | -p:: |
148 | --paginate:: | |
6acbcb92 JS |
149 | Pipe all output into 'less' (or if set, $PAGER). |
150 | ||
463a849d MM |
151 | --no-pager:: |
152 | Do not pipe git output into a pager. | |
153 | ||
6acbcb92 JS |
154 | --git-dir=<path>:: |
155 | Set the path to the repository. This can also be controlled by | |
302cc11a LY |
156 | setting the GIT_DIR environment variable. It can be an absolute |
157 | path or relative path to current working directory. | |
6acbcb92 | 158 | |
892c41b9 ML |
159 | --work-tree=<path>:: |
160 | Set the path to the working tree. The value will not be | |
161 | used in combination with repositories found automatically in | |
162 | a .git directory (i.e. $GIT_DIR is not set). | |
163 | This can also be controlled by setting the GIT_WORK_TREE | |
164 | environment variable and the core.worktree configuration | |
302cc11a LY |
165 | variable. It can be an absolute path or relative path to |
166 | the directory specified by --git-dir or GIT_DIR. | |
167 | Note: If --git-dir or GIT_DIR are specified but none of | |
168 | --work-tree, GIT_WORK_TREE and core.worktree is specified, | |
169 | the current working directory is regarded as the top directory | |
170 | of your working tree. | |
892c41b9 | 171 | |
6acbcb92 | 172 | --bare:: |
9277d602 JH |
173 | Treat the repository as a bare repository. If GIT_DIR |
174 | environment is not set, it is set to the current working | |
175 | directory. | |
176 | ||
9755afbd | 177 | |
23091e95 BF |
178 | FURTHER DOCUMENTATION |
179 | --------------------- | |
9755afbd | 180 | |
23091e95 BF |
181 | See the references above to get started using git. The following is |
182 | probably more detail than necessary for a first-time user. | |
8db9307c | 183 | |
40dac517 | 184 | The link:user-manual.html#git-concepts[git concepts chapter of the |
497c8331 | 185 | user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide |
40dac517 | 186 | introductions to the underlying git architecture. |
e6fc2346 | 187 | |
23091e95 BF |
188 | See also the link:howto-index.html[howto] documents for some useful |
189 | examples. | |
9755afbd | 190 | |
530e741c JH |
191 | The internals are documented link:technical/api-index.html[here]. |
192 | ||
23091e95 BF |
193 | GIT COMMANDS |
194 | ------------ | |
9755afbd | 195 | |
23091e95 BF |
196 | We divide git into high level ("porcelain") commands and low level |
197 | ("plumbing") commands. | |
8b15e2fb | 198 | |
23091e95 BF |
199 | High-level commands (porcelain) |
200 | ------------------------------- | |
201 | ||
202 | We separate the porcelain commands into the main commands and some | |
203 | ancillary user utilities. | |
204 | ||
205 | Main porcelain commands | |
206 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 207 | |
377e8139 | 208 | include::cmds-mainporcelain.txt[] |
e31bb3bb | 209 | |
90933efb | 210 | Ancillary Commands |
23091e95 | 211 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
212 | Manipulators: |
213 | ||
377e8139 | 214 | include::cmds-ancillarymanipulators.txt[] |
204ee6a9 | 215 | |
90933efb | 216 | Interrogators: |
204ee6a9 | 217 | |
377e8139 | 218 | include::cmds-ancillaryinterrogators.txt[] |
7fc9d69f | 219 | |
89bf2077 JH |
220 | |
221 | Interacting with Others | |
222 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
223 | ||
224 | These commands are to interact with foreign SCM and with other | |
225 | people via patch over e-mail. | |
226 | ||
227 | include::cmds-foreignscminterface.txt[] | |
228 | ||
229 | ||
b1f33d62 RR |
230 | Low-level commands (plumbing) |
231 | ----------------------------- | |
232 | ||
233 | Although git includes its | |
234 | own porcelain layer, its low-level commands are sufficient to support | |
235 | development of alternative porcelains. Developers of such porcelains | |
5162e697 DM |
236 | might start by reading about linkgit:git-update-index[1] and |
237 | linkgit:git-read-tree[1]. | |
b1f33d62 | 238 | |
89bf2077 JH |
239 | The interface (input, output, set of options and the semantics) |
240 | to these low-level commands are meant to be a lot more stable | |
241 | than Porcelain level commands, because these commands are | |
242 | primarily for scripted use. The interface to Porcelain commands | |
243 | on the other hand are subject to change in order to improve the | |
244 | end user experience. | |
245 | ||
246 | The following description divides | |
247 | the low-level commands into commands that manipulate objects (in | |
b1f33d62 RR |
248 | the repository, index, and working tree), commands that interrogate and |
249 | compare objects, and commands that move objects and references between | |
250 | repositories. | |
251 | ||
89bf2077 | 252 | |
b1f33d62 RR |
253 | Manipulation commands |
254 | ~~~~~~~~~~~~~~~~~~~~~ | |
b1f33d62 | 255 | |
377e8139 | 256 | include::cmds-plumbingmanipulators.txt[] |
b1f33d62 RR |
257 | |
258 | ||
259 | Interrogation commands | |
260 | ~~~~~~~~~~~~~~~~~~~~~~ | |
261 | ||
377e8139 | 262 | include::cmds-plumbinginterrogators.txt[] |
b1f33d62 RR |
263 | |
264 | In general, the interrogate commands do not touch the files in | |
265 | the working tree. | |
266 | ||
267 | ||
268 | Synching repositories | |
269 | ~~~~~~~~~~~~~~~~~~~~~ | |
270 | ||
377e8139 | 271 | include::cmds-synchingrepositories.txt[] |
b1f33d62 | 272 | |
89bf2077 JH |
273 | The following are helper programs used by the above; end users |
274 | typically do not use them directly. | |
275 | ||
276 | include::cmds-synchelpers.txt[] | |
277 | ||
278 | ||
279 | Internal helper commands | |
280 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
281 | ||
282 | These are internal helper commands used by other commands; end | |
283 | users typically do not use them directly. | |
284 | ||
285 | include::cmds-purehelpers.txt[] | |
286 | ||
b1f33d62 | 287 | |
5773c9f2 JH |
288 | Configuration Mechanism |
289 | ----------------------- | |
290 | ||
2fa090b6 | 291 | Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file |
5773c9f2 | 292 | is used to hold per-repository configuration options. It is a |
addf88e4 | 293 | simple text file modeled after `.ini` format familiar to some |
5773c9f2 JH |
294 | people. Here is an example: |
295 | ||
296 | ------------ | |
297 | # | |
2fa090b6 | 298 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
299 | # |
300 | ||
301 | ; core variables | |
302 | [core] | |
303 | ; Don't trust file modes | |
304 | filemode = false | |
305 | ||
306 | ; user identity | |
307 | [user] | |
308 | name = "Junio C Hamano" | |
309 | email = "junkio@twinsun.com" | |
310 | ||
311 | ------------ | |
312 | ||
313 | Various commands read from the configuration file and adjust | |
314 | their operation accordingly. | |
315 | ||
316 | ||
6c84e2e0 | 317 | Identifier Terminology |
2cf565c5 DG |
318 | ---------------------- |
319 | <object>:: | |
2fa090b6 | 320 | Indicates the object name for any type of object. |
2cf565c5 DG |
321 | |
322 | <blob>:: | |
2fa090b6 | 323 | Indicates a blob object name. |
2cf565c5 DG |
324 | |
325 | <tree>:: | |
2fa090b6 | 326 | Indicates a tree object name. |
2cf565c5 DG |
327 | |
328 | <commit>:: | |
2fa090b6 | 329 | Indicates a commit object name. |
2cf565c5 DG |
330 | |
331 | <tree-ish>:: | |
2fa090b6 | 332 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
333 | command that takes a <tree-ish> argument ultimately wants to |
334 | operate on a <tree> object but automatically dereferences | |
335 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 | 336 | |
043d7605 TT |
337 | <commit-ish>:: |
338 | Indicates a commit or tag object name. A | |
339 | command that takes a <commit-ish> argument ultimately wants to | |
340 | operate on a <commit> object but automatically dereferences | |
341 | <tag> objects that point at a <commit>. | |
342 | ||
2cf565c5 DG |
343 | <type>:: |
344 | Indicates that an object type is required. | |
2fa090b6 | 345 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
346 | |
347 | <file>:: | |
2fa090b6 JH |
348 | Indicates a filename - almost always relative to the |
349 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 350 | |
c1bdacf9 DG |
351 | Symbolic Identifiers |
352 | -------------------- | |
90933efb | 353 | Any git command accepting any <object> can also use the following |
6c84e2e0 | 354 | symbolic notation: |
c1bdacf9 DG |
355 | |
356 | HEAD:: | |
2fa090b6 JH |
357 | indicates the head of the current branch (i.e. the |
358 | contents of `$GIT_DIR/HEAD`). | |
359 | ||
c1bdacf9 | 360 | <tag>:: |
2fa090b6 JH |
361 | a valid tag 'name' |
362 | (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`). | |
363 | ||
c1bdacf9 | 364 | <head>:: |
2fa090b6 JH |
365 | a valid head 'name' |
366 | (i.e. the contents of `$GIT_DIR/refs/heads/<head>`). | |
367 | ||
d47107d8 | 368 | For a more complete list of ways to spell object names, see |
5162e697 | 369 | "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. |
d47107d8 | 370 | |
c1bdacf9 DG |
371 | |
372 | File/Directory Structure | |
373 | ------------------------ | |
c1bdacf9 | 374 | |
30eba7bf CC |
375 | Please see the linkgit:gitrepository-layout[5][repository layout] |
376 | document. | |
c1bdacf9 | 377 | |
a5af0e2c | 378 | Read linkgit:githooks[5][hooks] for more details about each hook. |
6250ad1e | 379 | |
c1bdacf9 | 380 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 381 | `$GIT_DIR`. |
c1bdacf9 | 382 | |
a1d4aa74 | 383 | |
2cf565c5 DG |
384 | Terminology |
385 | ----------- | |
497c8331 | 386 | Please see the linkgit:gitglossary[7][glossary] document. |
2cf565c5 DG |
387 | |
388 | ||
389 | Environment Variables | |
390 | --------------------- | |
391 | Various git commands use the following environment variables: | |
392 | ||
c1bdacf9 DG |
393 | The git Repository |
394 | ~~~~~~~~~~~~~~~~~~ | |
395 | These environment variables apply to 'all' core git commands. Nb: it | |
396 | is worth noting that they may be used/overridden by SCMS sitting above | |
2fa090b6 | 397 | git so take care if using Cogito etc. |
c1bdacf9 DG |
398 | |
399 | 'GIT_INDEX_FILE':: | |
400 | This environment allows the specification of an alternate | |
5f3aa197 LS |
401 | index file. If not specified, the default of `$GIT_DIR/index` |
402 | is used. | |
c1bdacf9 DG |
403 | |
404 | 'GIT_OBJECT_DIRECTORY':: | |
405 | If the object storage directory is specified via this | |
406 | environment variable then the sha1 directories are created | |
407 | underneath - otherwise the default `$GIT_DIR/objects` | |
408 | directory is used. | |
409 | ||
410 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
411 | Due to the immutable nature of git objects, old objects can be | |
412 | archived into shared, read-only directories. This variable | |
90933efb | 413 | specifies a ":" separated list of git object directories which |
c1bdacf9 DG |
414 | can be used to search for git objects. New objects will not be |
415 | written to these directories. | |
416 | ||
417 | 'GIT_DIR':: | |
2fa090b6 JH |
418 | If the 'GIT_DIR' environment variable is set then it |
419 | specifies a path to use instead of the default `.git` | |
420 | for the base of the repository. | |
c1bdacf9 | 421 | |
892c41b9 ML |
422 | 'GIT_WORK_TREE':: |
423 | Set the path to the working tree. The value will not be | |
424 | used in combination with repositories found automatically in | |
425 | a .git directory (i.e. $GIT_DIR is not set). | |
426 | This can also be controlled by the '--work-tree' command line | |
427 | option and the core.worktree configuration variable. | |
428 | ||
c1bdacf9 DG |
429 | git Commits |
430 | ~~~~~~~~~~~ | |
431 | 'GIT_AUTHOR_NAME':: | |
432 | 'GIT_AUTHOR_EMAIL':: | |
433 | 'GIT_AUTHOR_DATE':: | |
434 | 'GIT_COMMITTER_NAME':: | |
435 | 'GIT_COMMITTER_EMAIL':: | |
4e58bf97 | 436 | 'GIT_COMMITTER_DATE':: |
28a94f88 | 437 | 'EMAIL':: |
5162e697 | 438 | see linkgit:git-commit-tree[1] |
c1bdacf9 DG |
439 | |
440 | git Diffs | |
441 | ~~~~~~~~~ | |
d81ed1b5 | 442 | 'GIT_DIFF_OPTS':: |
fde97d8a SE |
443 | Only valid setting is "--unified=??" or "-u??" to set the |
444 | number of context lines shown when a unified diff is created. | |
445 | This takes precedence over any "-U" or "--unified" option | |
446 | value passed on the git diff command line. | |
447 | ||
d81ed1b5 | 448 | 'GIT_EXTERNAL_DIFF':: |
fde97d8a SE |
449 | When the environment variable 'GIT_EXTERNAL_DIFF' is set, the |
450 | program named by it is called, instead of the diff invocation | |
451 | described above. For a path that is added, removed, or modified, | |
452 | 'GIT_EXTERNAL_DIFF' is called with 7 parameters: | |
453 | ||
454 | path old-file old-hex old-mode new-file new-hex new-mode | |
455 | + | |
456 | where: | |
457 | ||
458 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the | |
459 | contents of <old|new>, | |
460 | <old|new>-hex:: are the 40-hexdigit SHA1 hashes, | |
461 | <old|new>-mode:: are the octal representation of the file modes. | |
462 | ||
463 | + | |
464 | The file parameters can point at the user's working file | |
465 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` | |
466 | when a new file is added), or a temporary file (e.g. `old-file` in the | |
467 | index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the | |
468 | temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. | |
469 | + | |
470 | For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 | |
471 | parameter, <path>. | |
2cf565c5 | 472 | |
575ba9d6 ML |
473 | other |
474 | ~~~~~ | |
dbddb714 JN |
475 | 'GIT_MERGE_VERBOSITY':: |
476 | A number controlling the amount of output shown by | |
477 | the recursive merge strategy. Overrides merge.verbosity. | |
5162e697 | 478 | See linkgit:git-merge[1] |
dbddb714 | 479 | |
c27d205a | 480 | 'GIT_PAGER':: |
a7738c77 SG |
481 | This environment variable overrides `$PAGER`. If it is set |
482 | to an empty string or to the value "cat", git will not launch | |
483 | a pager. | |
c27d205a | 484 | |
d5538b41 | 485 | 'GIT_SSH':: |
5162e697 DM |
486 | If this environment variable is set then linkgit:git-fetch[1] |
487 | and linkgit:git-push[1] will use this command instead | |
d5538b41 SP |
488 | of `ssh` when they need to connect to a remote system. |
489 | The 'GIT_SSH' command will be given exactly two arguments: | |
490 | the 'username@host' (or just 'host') from the URL and the | |
491 | shell command to execute on that remote system. | |
492 | + | |
493 | To pass options to the program that you want to list in GIT_SSH | |
494 | you will need to wrap the program and options into a shell script, | |
495 | then set GIT_SSH to refer to the shell script. | |
496 | + | |
497 | Usually it is easier to configure any desired options through your | |
498 | personal `.ssh/config` file. Please consult your ssh documentation | |
499 | for further details. | |
500 | ||
06f59e9f TT |
501 | 'GIT_FLUSH':: |
502 | If this environment variable is set to "1", then commands such | |
503 | as git-blame (in incremental mode), git-rev-list, git-log, | |
504 | git-whatchanged, etc., will force a flush of the output stream | |
505 | after each commit-oriented record have been flushed. If this | |
506 | variable is set to "0", the output of these commands will be done | |
507 | using completely buffered I/O. If this environment variable is | |
508 | not set, git will choose buffered or record-oriented flushing | |
509 | based on whether stdout appears to be redirected to a file or not. | |
510 | ||
575ba9d6 | 511 | 'GIT_TRACE':: |
2886bdb1 CC |
512 | If this variable is set to "1", "2" or "true" (comparison |
513 | is case insensitive), git will print `trace:` messages on | |
575ba9d6 ML |
514 | stderr telling about alias expansion, built-in command |
515 | execution and external command execution. | |
2886bdb1 CC |
516 | If this variable is set to an integer value greater than 1 |
517 | and lower than 10 (strictly) then git will interpret this | |
518 | value as an open file descriptor and will try to write the | |
519 | trace messages into this file descriptor. | |
520 | Alternatively, if this variable is set to an absolute path | |
521 | (starting with a '/' character), git will interpret this | |
522 | as a file path and will try to write the trace messages | |
523 | into it. | |
575ba9d6 | 524 | |
8db9307c JH |
525 | Discussion[[Discussion]] |
526 | ------------------------ | |
40dac517 BF |
527 | |
528 | More detail on the following is available from the | |
529 | link:user-manual.html#git-concepts[git concepts chapter of the | |
497c8331 | 530 | user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial]. |
40dac517 BF |
531 | |
532 | A git project normally consists of a working directory with a ".git" | |
533 | subdirectory at the top level. The .git directory contains, among other | |
534 | things, a compressed object database representing the complete history | |
535 | of the project, an "index" file which links that history to the current | |
536 | contents of the working tree, and named pointers into that history such | |
537 | as tags and branch heads. | |
538 | ||
539 | The object database contains objects of three main types: blobs, which | |
540 | hold file data; trees, which point to blobs and other trees to build up | |
02ff6250 | 541 | directory hierarchies; and commits, which each reference a single tree |
40dac517 BF |
542 | and some number of parent commits. |
543 | ||
544 | The commit, equivalent to what other systems call a "changeset" or | |
545 | "version", represents a step in the project's history, and each parent | |
546 | represents an immediately preceding step. Commits with more than one | |
547 | parent represent merges of independent lines of development. | |
548 | ||
549 | All objects are named by the SHA1 hash of their contents, normally | |
550 | written as a string of 40 hex digits. Such names are globally unique. | |
551 | The entire history leading up to a commit can be vouched for by signing | |
552 | just that commit. A fourth object type, the tag, is provided for this | |
553 | purpose. | |
554 | ||
555 | When first created, objects are stored in individual files, but for | |
556 | efficiency may later be compressed together into "pack files". | |
557 | ||
558 | Named pointers called refs mark interesting points in history. A ref | |
559 | may contain the SHA1 name of an object or the name of another ref. Refs | |
560 | with names beginning `ref/head/` contain the SHA1 name of the most | |
02ff6250 | 561 | recent commit (or "head") of a branch under development. SHA1 names of |
40dac517 BF |
562 | tags of interest are stored under `ref/tags/`. A special ref named |
563 | `HEAD` contains the name of the currently checked-out branch. | |
564 | ||
565 | The index file is initialized with a list of all paths and, for each | |
566 | path, a blob object and a set of attributes. The blob object represents | |
567 | the contents of the file as of the head of the current branch. The | |
568 | attributes (last modified time, size, etc.) are taken from the | |
569 | corresponding file in the working tree. Subsequent changes to the | |
570 | working tree can be found by comparing these attributes. The index may | |
571 | be updated with new content, and new commits may be created from the | |
572 | content stored in the index. | |
573 | ||
574 | The index is also capable of storing multiple entries (called "stages") | |
575 | for a given pathname. These stages are used to hold the various | |
576 | unmerged version of a file when a merge is in progress. | |
6c84e2e0 | 577 | |
cb22bc44 AE |
578 | Authors |
579 | ------- | |
9755afbd | 580 | * git's founding father is Linus Torvalds <torvalds@osdl.org>. |
947ad2e1 | 581 | * The current git nurse is Junio C Hamano <gitster@pobox.com>. |
0240e21a | 582 | * The git potty was written by Andreas Ericsson <ae@op5.se>. |
9755afbd | 583 | * General upbringing is handled by the git-list <git@vger.kernel.org>. |
2cf565c5 DG |
584 | |
585 | Documentation | |
586 | -------------- | |
9755afbd JH |
587 | The documentation for git suite was started by David Greaves |
588 | <david@dgreaves.com>, and later enhanced greatly by the | |
589 | contributors on the git-list <git@vger.kernel.org>. | |
2cf565c5 | 590 | |
497c8331 CC |
591 | SEE ALSO |
592 | -------- | |
593 | linkgit:gittutorial[7], linkgit:gittutorial-2[7], | |
594 | linkgit:giteveryday[7], linkgit:gitcvs-migration[7], | |
595 | linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], | |
596 | link:user-manual.html[The Git User's Manual] | |
597 | ||
2cf565c5 DG |
598 | GIT |
599 | --- | |
9e1f0a85 | 600 | Part of the linkgit:git[1] suite |