6 git - the stupid content tracker
12 'git' [--version] [--help] [-c <name>=<value>]
13 [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
14 [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
15 [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
20 Git is a fast, scalable, distributed revision control system with an
21 unusually rich command set that provides both high-level operations
22 and full access to internals.
24 See linkgit:gittutorial[7] to get started, then see
25 link:everyday.html[Everyday Git] for a useful minimum set of
26 commands. The link:user-manual.html[Git User's Manual] has a more
27 in-depth introduction.
29 After you mastered the basic concepts, you can come back to this
30 page to learn what commands Git offers. You can learn more about
31 individual Git commands with "git help command". linkgit:gitcli[7]
32 manual page gives you an overview of the command line command syntax.
34 Formatted and hyperlinked version of the latest Git documentation
35 can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
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:
46 * link:v1.8.3.2/git.html[documentation for release 1.8.3.2]
49 link:RelNotes/1.8.3.2.txt[1.8.3.2],
50 link:RelNotes/1.8.3.1.txt[1.8.3.1],
51 link:RelNotes/1.8.3.txt[1.8.3].
53 * link:v1.8.2.3/git.html[documentation for release 1.8.2.3]
56 link:RelNotes/1.8.2.3.txt[1.8.2.3].
57 link:RelNotes/1.8.2.2.txt[1.8.2.2].
58 link:RelNotes/1.8.2.1.txt[1.8.2.1].
59 link:RelNotes/1.8.2.txt[1.8.2].
61 * link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
64 link:RelNotes/1.8.1.6.txt[1.8.1.6],
65 link:RelNotes/1.8.1.5.txt[1.8.1.5],
66 link:RelNotes/1.8.1.4.txt[1.8.1.4],
67 link:RelNotes/1.8.1.3.txt[1.8.1.3],
68 link:RelNotes/1.8.1.2.txt[1.8.1.2],
69 link:RelNotes/1.8.1.1.txt[1.8.1.1],
70 link:RelNotes/1.8.1.txt[1.8.1].
72 * link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
75 link:RelNotes/1.8.0.3.txt[1.8.0.3],
76 link:RelNotes/1.8.0.2.txt[1.8.0.2],
77 link:RelNotes/1.8.0.1.txt[1.8.0.1],
78 link:RelNotes/1.8.0.txt[1.8.0].
80 * link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
83 link:RelNotes/1.7.12.4.txt[1.7.12.4],
84 link:RelNotes/1.7.12.3.txt[1.7.12.3],
85 link:RelNotes/1.7.12.2.txt[1.7.12.2],
86 link:RelNotes/1.7.12.1.txt[1.7.12.1],
87 link:RelNotes/1.7.12.txt[1.7.12].
89 * link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
92 link:RelNotes/1.7.11.7.txt[1.7.11.7],
93 link:RelNotes/1.7.11.6.txt[1.7.11.6],
94 link:RelNotes/1.7.11.5.txt[1.7.11.5],
95 link:RelNotes/1.7.11.4.txt[1.7.11.4],
96 link:RelNotes/1.7.11.3.txt[1.7.11.3],
97 link:RelNotes/1.7.11.2.txt[1.7.11.2],
98 link:RelNotes/1.7.11.1.txt[1.7.11.1],
99 link:RelNotes/1.7.11.txt[1.7.11].
101 * link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
104 link:RelNotes/1.7.10.5.txt[1.7.10.5],
105 link:RelNotes/1.7.10.4.txt[1.7.10.4],
106 link:RelNotes/1.7.10.3.txt[1.7.10.3],
107 link:RelNotes/1.7.10.2.txt[1.7.10.2],
108 link:RelNotes/1.7.10.1.txt[1.7.10.1],
109 link:RelNotes/1.7.10.txt[1.7.10].
111 * link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
114 link:RelNotes/1.7.9.7.txt[1.7.9.7],
115 link:RelNotes/1.7.9.6.txt[1.7.9.6],
116 link:RelNotes/1.7.9.5.txt[1.7.9.5],
117 link:RelNotes/1.7.9.4.txt[1.7.9.4],
118 link:RelNotes/1.7.9.3.txt[1.7.9.3],
119 link:RelNotes/1.7.9.2.txt[1.7.9.2],
120 link:RelNotes/1.7.9.1.txt[1.7.9.1],
121 link:RelNotes/1.7.9.txt[1.7.9].
123 * link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
126 link:RelNotes/1.7.8.6.txt[1.7.8.6],
127 link:RelNotes/1.7.8.5.txt[1.7.8.5],
128 link:RelNotes/1.7.8.4.txt[1.7.8.4],
129 link:RelNotes/1.7.8.3.txt[1.7.8.3],
130 link:RelNotes/1.7.8.2.txt[1.7.8.2],
131 link:RelNotes/1.7.8.1.txt[1.7.8.1],
132 link:RelNotes/1.7.8.txt[1.7.8].
134 * link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
137 link:RelNotes/1.7.7.7.txt[1.7.7.7],
138 link:RelNotes/1.7.7.6.txt[1.7.7.6],
139 link:RelNotes/1.7.7.5.txt[1.7.7.5],
140 link:RelNotes/1.7.7.4.txt[1.7.7.4],
141 link:RelNotes/1.7.7.3.txt[1.7.7.3],
142 link:RelNotes/1.7.7.2.txt[1.7.7.2],
143 link:RelNotes/1.7.7.1.txt[1.7.7.1],
144 link:RelNotes/1.7.7.txt[1.7.7].
146 * link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
149 link:RelNotes/1.7.6.6.txt[1.7.6.6],
150 link:RelNotes/1.7.6.5.txt[1.7.6.5],
151 link:RelNotes/1.7.6.4.txt[1.7.6.4],
152 link:RelNotes/1.7.6.3.txt[1.7.6.3],
153 link:RelNotes/1.7.6.2.txt[1.7.6.2],
154 link:RelNotes/1.7.6.1.txt[1.7.6.1],
155 link:RelNotes/1.7.6.txt[1.7.6].
157 * link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
160 link:RelNotes/1.7.5.4.txt[1.7.5.4],
161 link:RelNotes/1.7.5.3.txt[1.7.5.3],
162 link:RelNotes/1.7.5.2.txt[1.7.5.2],
163 link:RelNotes/1.7.5.1.txt[1.7.5.1],
164 link:RelNotes/1.7.5.txt[1.7.5].
166 * link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
169 link:RelNotes/1.7.4.5.txt[1.7.4.5],
170 link:RelNotes/1.7.4.4.txt[1.7.4.4],
171 link:RelNotes/1.7.4.3.txt[1.7.4.3],
172 link:RelNotes/1.7.4.2.txt[1.7.4.2],
173 link:RelNotes/1.7.4.1.txt[1.7.4.1],
174 link:RelNotes/1.7.4.txt[1.7.4].
176 * link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
179 link:RelNotes/1.7.3.5.txt[1.7.3.5],
180 link:RelNotes/1.7.3.4.txt[1.7.3.4],
181 link:RelNotes/1.7.3.3.txt[1.7.3.3],
182 link:RelNotes/1.7.3.2.txt[1.7.3.2],
183 link:RelNotes/1.7.3.1.txt[1.7.3.1],
184 link:RelNotes/1.7.3.txt[1.7.3].
186 * link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
189 link:RelNotes/1.7.2.5.txt[1.7.2.5],
190 link:RelNotes/1.7.2.4.txt[1.7.2.4],
191 link:RelNotes/1.7.2.3.txt[1.7.2.3],
192 link:RelNotes/1.7.2.2.txt[1.7.2.2],
193 link:RelNotes/1.7.2.1.txt[1.7.2.1],
194 link:RelNotes/1.7.2.txt[1.7.2].
196 * link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
199 link:RelNotes/1.7.1.4.txt[1.7.1.4],
200 link:RelNotes/1.7.1.3.txt[1.7.1.3],
201 link:RelNotes/1.7.1.2.txt[1.7.1.2],
202 link:RelNotes/1.7.1.1.txt[1.7.1.1],
203 link:RelNotes/1.7.1.txt[1.7.1].
205 * link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
208 link:RelNotes/1.7.0.9.txt[1.7.0.9],
209 link:RelNotes/1.7.0.8.txt[1.7.0.8],
210 link:RelNotes/1.7.0.7.txt[1.7.0.7],
211 link:RelNotes/1.7.0.6.txt[1.7.0.6],
212 link:RelNotes/1.7.0.5.txt[1.7.0.5],
213 link:RelNotes/1.7.0.4.txt[1.7.0.4],
214 link:RelNotes/1.7.0.3.txt[1.7.0.3],
215 link:RelNotes/1.7.0.2.txt[1.7.0.2],
216 link:RelNotes/1.7.0.1.txt[1.7.0.1],
217 link:RelNotes/1.7.0.txt[1.7.0].
219 * link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
222 link:RelNotes/1.6.6.3.txt[1.6.6.3],
223 link:RelNotes/1.6.6.2.txt[1.6.6.2],
224 link:RelNotes/1.6.6.1.txt[1.6.6.1],
225 link:RelNotes/1.6.6.txt[1.6.6].
227 * link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
230 link:RelNotes/1.6.5.9.txt[1.6.5.9],
231 link:RelNotes/1.6.5.8.txt[1.6.5.8],
232 link:RelNotes/1.6.5.7.txt[1.6.5.7],
233 link:RelNotes/1.6.5.6.txt[1.6.5.6],
234 link:RelNotes/1.6.5.5.txt[1.6.5.5],
235 link:RelNotes/1.6.5.4.txt[1.6.5.4],
236 link:RelNotes/1.6.5.3.txt[1.6.5.3],
237 link:RelNotes/1.6.5.2.txt[1.6.5.2],
238 link:RelNotes/1.6.5.1.txt[1.6.5.1],
239 link:RelNotes/1.6.5.txt[1.6.5].
241 * link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
244 link:RelNotes/1.6.4.5.txt[1.6.4.5],
245 link:RelNotes/1.6.4.4.txt[1.6.4.4],
246 link:RelNotes/1.6.4.3.txt[1.6.4.3],
247 link:RelNotes/1.6.4.2.txt[1.6.4.2],
248 link:RelNotes/1.6.4.1.txt[1.6.4.1],
249 link:RelNotes/1.6.4.txt[1.6.4].
251 * link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
254 link:RelNotes/1.6.3.4.txt[1.6.3.4],
255 link:RelNotes/1.6.3.3.txt[1.6.3.3],
256 link:RelNotes/1.6.3.2.txt[1.6.3.2],
257 link:RelNotes/1.6.3.1.txt[1.6.3.1],
258 link:RelNotes/1.6.3.txt[1.6.3].
261 link:RelNotes/1.6.2.5.txt[1.6.2.5],
262 link:RelNotes/1.6.2.4.txt[1.6.2.4],
263 link:RelNotes/1.6.2.3.txt[1.6.2.3],
264 link:RelNotes/1.6.2.2.txt[1.6.2.2],
265 link:RelNotes/1.6.2.1.txt[1.6.2.1],
266 link:RelNotes/1.6.2.txt[1.6.2].
268 * link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
271 link:RelNotes/1.6.1.3.txt[1.6.1.3],
272 link:RelNotes/1.6.1.2.txt[1.6.1.2],
273 link:RelNotes/1.6.1.1.txt[1.6.1.1],
274 link:RelNotes/1.6.1.txt[1.6.1].
276 * link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
279 link:RelNotes/1.6.0.6.txt[1.6.0.6],
280 link:RelNotes/1.6.0.5.txt[1.6.0.5],
281 link:RelNotes/1.6.0.4.txt[1.6.0.4],
282 link:RelNotes/1.6.0.3.txt[1.6.0.3],
283 link:RelNotes/1.6.0.2.txt[1.6.0.2],
284 link:RelNotes/1.6.0.1.txt[1.6.0.1],
285 link:RelNotes/1.6.0.txt[1.6.0].
287 * link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
290 link:RelNotes/1.5.6.6.txt[1.5.6.6],
291 link:RelNotes/1.5.6.5.txt[1.5.6.5],
292 link:RelNotes/1.5.6.4.txt[1.5.6.4],
293 link:RelNotes/1.5.6.3.txt[1.5.6.3],
294 link:RelNotes/1.5.6.2.txt[1.5.6.2],
295 link:RelNotes/1.5.6.1.txt[1.5.6.1],
296 link:RelNotes/1.5.6.txt[1.5.6].
298 * link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
301 link:RelNotes/1.5.5.6.txt[1.5.5.6],
302 link:RelNotes/1.5.5.5.txt[1.5.5.5],
303 link:RelNotes/1.5.5.4.txt[1.5.5.4],
304 link:RelNotes/1.5.5.3.txt[1.5.5.3],
305 link:RelNotes/1.5.5.2.txt[1.5.5.2],
306 link:RelNotes/1.5.5.1.txt[1.5.5.1],
307 link:RelNotes/1.5.5.txt[1.5.5].
309 * link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
312 link:RelNotes/1.5.4.7.txt[1.5.4.7],
313 link:RelNotes/1.5.4.6.txt[1.5.4.6],
314 link:RelNotes/1.5.4.5.txt[1.5.4.5],
315 link:RelNotes/1.5.4.4.txt[1.5.4.4],
316 link:RelNotes/1.5.4.3.txt[1.5.4.3],
317 link:RelNotes/1.5.4.2.txt[1.5.4.2],
318 link:RelNotes/1.5.4.1.txt[1.5.4.1],
319 link:RelNotes/1.5.4.txt[1.5.4].
321 * link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
324 link:RelNotes/1.5.3.8.txt[1.5.3.8],
325 link:RelNotes/1.5.3.7.txt[1.5.3.7],
326 link:RelNotes/1.5.3.6.txt[1.5.3.6],
327 link:RelNotes/1.5.3.5.txt[1.5.3.5],
328 link:RelNotes/1.5.3.4.txt[1.5.3.4],
329 link:RelNotes/1.5.3.3.txt[1.5.3.3],
330 link:RelNotes/1.5.3.2.txt[1.5.3.2],
331 link:RelNotes/1.5.3.1.txt[1.5.3.1],
332 link:RelNotes/1.5.3.txt[1.5.3].
334 * link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
337 link:RelNotes/1.5.2.5.txt[1.5.2.5],
338 link:RelNotes/1.5.2.4.txt[1.5.2.4],
339 link:RelNotes/1.5.2.3.txt[1.5.2.3],
340 link:RelNotes/1.5.2.2.txt[1.5.2.2],
341 link:RelNotes/1.5.2.1.txt[1.5.2.1],
342 link:RelNotes/1.5.2.txt[1.5.2].
344 * link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
347 link:RelNotes/1.5.1.6.txt[1.5.1.6],
348 link:RelNotes/1.5.1.5.txt[1.5.1.5],
349 link:RelNotes/1.5.1.4.txt[1.5.1.4],
350 link:RelNotes/1.5.1.3.txt[1.5.1.3],
351 link:RelNotes/1.5.1.2.txt[1.5.1.2],
352 link:RelNotes/1.5.1.1.txt[1.5.1.1],
353 link:RelNotes/1.5.1.txt[1.5.1].
355 * link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
358 link:RelNotes/1.5.0.7.txt[1.5.0.7],
359 link:RelNotes/1.5.0.6.txt[1.5.0.6],
360 link:RelNotes/1.5.0.5.txt[1.5.0.5],
361 link:RelNotes/1.5.0.3.txt[1.5.0.3],
362 link:RelNotes/1.5.0.2.txt[1.5.0.2],
363 link:RelNotes/1.5.0.1.txt[1.5.0.1],
364 link:RelNotes/1.5.0.txt[1.5.0].
366 * documentation for release link:v1.4.4.4/git.html[1.4.4.4],
367 link:v1.3.3/git.html[1.3.3],
368 link:v1.2.6/git.html[1.2.6],
369 link:v1.0.13/git.html[1.0.13].
378 Prints the Git suite version that the 'git' program came from.
381 Prints the synopsis and a list of the most commonly used
382 commands. If the option '--all' or '-a' is given then all
383 available commands are printed. If a Git command is named this
384 option will bring up the manual page for that command.
386 Other options are available to control how the manual page is
387 displayed. See linkgit:git-help[1] for more information,
388 because `git --help ...` is converted internally into `git
392 Pass a configuration parameter to the command. The value
393 given will override values from configuration files.
394 The <name> is expected in the same format as listed by
395 'git config' (subkeys separated by dots).
397 --exec-path[=<path>]::
398 Path to wherever your core Git programs are installed.
399 This can also be controlled by setting the GIT_EXEC_PATH
400 environment variable. If no path is given, 'git' will print
401 the current setting and then exit.
404 Print the path, without trailing slash, where Git's HTML
405 documentation is installed and exit.
408 Print the manpath (see `man(1)`) for the man pages for
409 this version of Git and exit.
412 Print the path where the Info files documenting this
413 version of Git are installed and exit.
417 Pipe all output into 'less' (or if set, $PAGER) if standard
418 output is a terminal. This overrides the `pager.<cmd>`
419 configuration options (see the "Configuration Mechanism" section
423 Do not pipe Git output into a pager.
426 Set the path to the repository. This can also be controlled by
427 setting the GIT_DIR environment variable. It can be an absolute
428 path or relative path to current working directory.
431 Set the path to the working tree. It can be an absolute path
432 or a path relative to the current working directory.
433 This can also be controlled by setting the GIT_WORK_TREE
434 environment variable and the core.worktree configuration
435 variable (see core.worktree in linkgit:git-config[1] for a
436 more detailed discussion).
439 Set the Git namespace. See linkgit:gitnamespaces[7] for more
440 details. Equivalent to setting the `GIT_NAMESPACE` environment
444 Treat the repository as a bare repository. If GIT_DIR
445 environment is not set, it is set to the current working
448 --no-replace-objects::
449 Do not use replacement refs to replace Git objects. See
450 linkgit:git-replace[1] for more information.
452 --literal-pathspecs::
453 Treat pathspecs literally, rather than as glob patterns. This is
454 equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
461 We divide Git into high level ("porcelain") commands and low level
462 ("plumbing") commands.
464 High-level commands (porcelain)
465 -------------------------------
467 We separate the porcelain commands into the main commands and some
468 ancillary user utilities.
470 Main porcelain commands
471 ~~~~~~~~~~~~~~~~~~~~~~~
473 include::cmds-mainporcelain.txt[]
479 include::cmds-ancillarymanipulators.txt[]
483 include::cmds-ancillaryinterrogators.txt[]
486 Interacting with Others
487 ~~~~~~~~~~~~~~~~~~~~~~~
489 These commands are to interact with foreign SCM and with other
490 people via patch over e-mail.
492 include::cmds-foreignscminterface.txt[]
495 Low-level commands (plumbing)
496 -----------------------------
498 Although Git includes its
499 own porcelain layer, its low-level commands are sufficient to support
500 development of alternative porcelains. Developers of such porcelains
501 might start by reading about linkgit:git-update-index[1] and
502 linkgit:git-read-tree[1].
504 The interface (input, output, set of options and the semantics)
505 to these low-level commands are meant to be a lot more stable
506 than Porcelain level commands, because these commands are
507 primarily for scripted use. The interface to Porcelain commands
508 on the other hand are subject to change in order to improve the
511 The following description divides
512 the low-level commands into commands that manipulate objects (in
513 the repository, index, and working tree), commands that interrogate and
514 compare objects, and commands that move objects and references between
518 Manipulation commands
519 ~~~~~~~~~~~~~~~~~~~~~
521 include::cmds-plumbingmanipulators.txt[]
524 Interrogation commands
525 ~~~~~~~~~~~~~~~~~~~~~~
527 include::cmds-plumbinginterrogators.txt[]
529 In general, the interrogate commands do not touch the files in
533 Synching repositories
534 ~~~~~~~~~~~~~~~~~~~~~
536 include::cmds-synchingrepositories.txt[]
538 The following are helper commands used by the above; end users
539 typically do not use them directly.
541 include::cmds-synchelpers.txt[]
544 Internal helper commands
545 ~~~~~~~~~~~~~~~~~~~~~~~~
547 These are internal helper commands used by other commands; end
548 users typically do not use them directly.
550 include::cmds-purehelpers.txt[]
553 Configuration Mechanism
554 -----------------------
556 Git uses a simple text format to store customizations that are per
557 repository and are per user. Such a configuration file may look
562 # A '#' or ';' character indicates a comment.
567 ; Don't trust file modes
572 name = "Junio C Hamano"
573 email = "gitster@pobox.com"
577 Various commands read from the configuration file and adjust
578 their operation accordingly. See linkgit:git-config[1] for a
579 list and more details about the configuration mechanism.
582 Identifier Terminology
583 ----------------------
585 Indicates the object name for any type of object.
588 Indicates a blob object name.
591 Indicates a tree object name.
594 Indicates a commit object name.
597 Indicates a tree, commit or tag object name. A
598 command that takes a <tree-ish> argument ultimately wants to
599 operate on a <tree> object but automatically dereferences
600 <commit> and <tag> objects that point at a <tree>.
603 Indicates a commit or tag object name. A
604 command that takes a <commit-ish> argument ultimately wants to
605 operate on a <commit> object but automatically dereferences
606 <tag> objects that point at a <commit>.
609 Indicates that an object type is required.
610 Currently one of: `blob`, `tree`, `commit`, or `tag`.
613 Indicates a filename - almost always relative to the
614 root of the tree structure `GIT_INDEX_FILE` describes.
618 Any Git command accepting any <object> can also use the following
622 indicates the head of the current branch.
626 (i.e. a `refs/tags/<tag>` reference).
630 (i.e. a `refs/heads/<head>` reference).
632 For a more complete list of ways to spell object names, see
633 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
636 File/Directory Structure
637 ------------------------
639 Please see the linkgit:gitrepository-layout[5] document.
641 Read linkgit:githooks[5] for more details about each hook.
643 Higher level SCMs may provide and manage additional information in the
649 Please see linkgit:gitglossary[7].
652 Environment Variables
653 ---------------------
654 Various Git commands use the following environment variables:
658 These environment variables apply to 'all' core Git commands. Nb: it
659 is worth noting that they may be used/overridden by SCMS sitting above
660 Git so take care if using Cogito etc.
663 This environment allows the specification of an alternate
664 index file. If not specified, the default of `$GIT_DIR/index`
667 'GIT_OBJECT_DIRECTORY'::
668 If the object storage directory is specified via this
669 environment variable then the sha1 directories are created
670 underneath - otherwise the default `$GIT_DIR/objects`
673 'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
674 Due to the immutable nature of Git objects, old objects can be
675 archived into shared, read-only directories. This variable
676 specifies a ":" separated (on Windows ";" separated) list
677 of Git object directories which can be used to search for Git
678 objects. New objects will not be written to these directories.
681 If the 'GIT_DIR' environment variable is set then it
682 specifies a path to use instead of the default `.git`
683 for the base of the repository.
684 The '--git-dir' command-line option also sets this value.
687 Set the path to the working tree. The value will not be
688 used in combination with repositories found automatically in
689 a .git directory (i.e. $GIT_DIR is not set).
690 This can also be controlled by the '--work-tree' command line
691 option and the core.worktree configuration variable.
694 Set the Git namespace; see linkgit:gitnamespaces[7] for details.
695 The '--namespace' command-line option also sets this value.
697 'GIT_CEILING_DIRECTORIES'::
698 This should be a colon-separated list of absolute paths. If
699 set, it is a list of directories that Git should not chdir up
700 into while looking for a repository directory (useful for
701 excluding slow-loading network directories). It will not
702 exclude the current working directory or a GIT_DIR set on the
703 command line or in the environment. Normally, Git has to read
704 the entries in this list and resolve any symlink that
705 might be present in order to compare them with the current
706 directory. However, if even this access is slow, you
707 can add an empty entry to the list to tell Git that the
708 subsequent entries are not symlinks and needn't be resolved;
710 'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
712 'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
713 When run in a directory that does not have ".git" repository
714 directory, Git tries to find such a directory in the parent
715 directories to find the top of the working tree, but by default it
716 does not cross filesystem boundaries. This environment variable
717 can be set to true to tell Git not to stop at filesystem
718 boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
719 an explicit repository directory set via 'GIT_DIR' or on the
727 'GIT_COMMITTER_NAME'::
728 'GIT_COMMITTER_EMAIL'::
729 'GIT_COMMITTER_DATE'::
731 see linkgit:git-commit-tree[1]
736 Only valid setting is "--unified=??" or "-u??" to set the
737 number of context lines shown when a unified diff is created.
738 This takes precedence over any "-U" or "--unified" option
739 value passed on the Git diff command line.
741 'GIT_EXTERNAL_DIFF'::
742 When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
743 program named by it is called, instead of the diff invocation
744 described above. For a path that is added, removed, or modified,
745 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
747 path old-file old-hex old-mode new-file new-hex new-mode
751 <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
752 contents of <old|new>,
753 <old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
754 <old|new>-mode:: are the octal representation of the file modes.
756 The file parameters can point at the user's working file
757 (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
758 when a new file is added), or a temporary file (e.g. `old-file` in the
759 index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
760 temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
762 For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
767 'GIT_MERGE_VERBOSITY'::
768 A number controlling the amount of output shown by
769 the recursive merge strategy. Overrides merge.verbosity.
770 See linkgit:git-merge[1]
773 This environment variable overrides `$PAGER`. If it is set
774 to an empty string or to the value "cat", Git will not launch
775 a pager. See also the `core.pager` option in
776 linkgit:git-config[1].
779 This environment variable overrides `$EDITOR` and `$VISUAL`.
780 It is used by several Git commands when, on interactive mode,
781 an editor is to be launched. See also linkgit:git-var[1]
782 and the `core.editor` option in linkgit:git-config[1].
785 If this environment variable is set then 'git fetch'
786 and 'git push' will use this command instead
787 of 'ssh' when they need to connect to a remote system.
788 The '$GIT_SSH' command will be given exactly two or
789 four arguments: the 'username@host' (or just 'host')
790 from the URL and the shell command to execute on that
791 remote system, optionally preceded by '-p' (literally) and
792 the 'port' from the URL when it specifies something other
793 than the default SSH port.
795 To pass options to the program that you want to list in GIT_SSH
796 you will need to wrap the program and options into a shell script,
797 then set GIT_SSH to refer to the shell script.
799 Usually it is easier to configure any desired options through your
800 personal `.ssh/config` file. Please consult your ssh documentation
804 If this environment variable is set, then Git commands which need to
805 acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
806 will call this program with a suitable prompt as command line argument
807 and read the password from its STDOUT. See also the 'core.askpass'
808 option in linkgit:git-config[1].
810 'GIT_CONFIG_NOSYSTEM'::
811 Whether to skip reading settings from the system-wide
812 `$(prefix)/etc/gitconfig` file. This environment variable can
813 be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
814 predictable environment for a picky script, or you can set it
815 temporarily to avoid using a buggy `/etc/gitconfig` file while
816 waiting for someone with sufficient permissions to fix it.
819 If this environment variable is set to "1", then commands such
820 as 'git blame' (in incremental mode), 'git rev-list', 'git log',
821 and 'git whatchanged' will force a flush of the output stream
822 after each commit-oriented record have been flushed. If this
823 variable is set to "0", the output of these commands will be done
824 using completely buffered I/O. If this environment variable is
825 not set, Git will choose buffered or record-oriented flushing
826 based on whether stdout appears to be redirected to a file or not.
829 If this variable is set to "1", "2" or "true" (comparison
830 is case insensitive), Git will print `trace:` messages on
831 stderr telling about alias expansion, built-in command
832 execution and external command execution.
833 If this variable is set to an integer value greater than 1
834 and lower than 10 (strictly) then Git will interpret this
835 value as an open file descriptor and will try to write the
836 trace messages into this file descriptor.
837 Alternatively, if this variable is set to an absolute path
838 (starting with a '/' character), Git will interpret this
839 as a file path and will try to write the trace messages
842 GIT_LITERAL_PATHSPECS::
843 Setting this variable to `1` will cause Git to treat all
844 pathspecs literally, rather than as glob patterns. For example,
845 running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
846 for commits that touch the path `*.c`, not any paths that the
847 glob `*.c` matches. You might want this if you are feeding
848 literal paths to Git (e.g., paths previously given to you by
849 `git ls-tree`, `--raw` diff output, etc).
852 Discussion[[Discussion]]
853 ------------------------
855 More detail on the following is available from the
856 link:user-manual.html#git-concepts[Git concepts chapter of the
857 user-manual] and linkgit:gitcore-tutorial[7].
859 A Git project normally consists of a working directory with a ".git"
860 subdirectory at the top level. The .git directory contains, among other
861 things, a compressed object database representing the complete history
862 of the project, an "index" file which links that history to the current
863 contents of the working tree, and named pointers into that history such
864 as tags and branch heads.
866 The object database contains objects of three main types: blobs, which
867 hold file data; trees, which point to blobs and other trees to build up
868 directory hierarchies; and commits, which each reference a single tree
869 and some number of parent commits.
871 The commit, equivalent to what other systems call a "changeset" or
872 "version", represents a step in the project's history, and each parent
873 represents an immediately preceding step. Commits with more than one
874 parent represent merges of independent lines of development.
876 All objects are named by the SHA-1 hash of their contents, normally
877 written as a string of 40 hex digits. Such names are globally unique.
878 The entire history leading up to a commit can be vouched for by signing
879 just that commit. A fourth object type, the tag, is provided for this
882 When first created, objects are stored in individual files, but for
883 efficiency may later be compressed together into "pack files".
885 Named pointers called refs mark interesting points in history. A ref
886 may contain the SHA-1 name of an object or the name of another ref. Refs
887 with names beginning `ref/head/` contain the SHA-1 name of the most
888 recent commit (or "head") of a branch under development. SHA-1 names of
889 tags of interest are stored under `ref/tags/`. A special ref named
890 `HEAD` contains the name of the currently checked-out branch.
892 The index file is initialized with a list of all paths and, for each
893 path, a blob object and a set of attributes. The blob object represents
894 the contents of the file as of the head of the current branch. The
895 attributes (last modified time, size, etc.) are taken from the
896 corresponding file in the working tree. Subsequent changes to the
897 working tree can be found by comparing these attributes. The index may
898 be updated with new content, and new commits may be created from the
899 content stored in the index.
901 The index is also capable of storing multiple entries (called "stages")
902 for a given pathname. These stages are used to hold the various
903 unmerged version of a file when a merge is in progress.
905 FURTHER DOCUMENTATION
906 ---------------------
908 See the references in the "description" section to get started
909 using Git. The following is probably more detail than necessary
910 for a first-time user.
912 The link:user-manual.html#git-concepts[Git concepts chapter of the
913 user-manual] and linkgit:gitcore-tutorial[7] both provide
914 introductions to the underlying Git architecture.
916 See linkgit:gitworkflows[7] for an overview of recommended workflows.
918 See also the link:howto-index.html[howto] documents for some useful
921 The internals are documented in the
922 link:technical/api-index.html[Git API documentation].
924 Users migrating from CVS may also want to
925 read linkgit:gitcvs-migration[7].
930 Git was started by Linus Torvalds, and is currently maintained by Junio
931 C Hamano. Numerous contributions have come from the Git mailing list
932 <git@vger.kernel.org>. http://www.ohloh.net/p/git/contributors/summary
933 gives you a more complete list of contributors.
935 If you have a clone of git.git itself, the
936 output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
937 the authors for specific parts of the project.
942 Report bugs to the Git mailing list <git@vger.kernel.org> where the
943 development and maintenance is primarily done. You do not have to be
944 subscribed to the list to send a message there.
948 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
949 link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
950 linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
951 linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
952 linkgit:gitworkflows[7]
956 Part of the linkgit:git[1] suite