blob: 27ece5885720c0db79e30a6de9663e3bdfb37f07 [file] [log] [blame]
Junio C Hamanof7c042d2008-06-06 22:50:531git(1)
Junio C Hamano1a4e8412005-12-27 08:17:232======
3
4NAME
5----
6git - the stupid content tracker
7
8
9SYNOPSIS
10--------
Junio C Hamano6b2cee12006-08-26 08:43:3111[verse]
Junio C Hamanob4a9ede2009-04-08 07:36:3212'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
Junio C Hamano3d23a0a2009-10-19 08:04:3013 [-p|--paginate|--no-pager] [--no-replace-objects]
Junio C Hamanod526ba92007-07-02 00:17:4214 [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
Junio C Hamanocc7636a2010-05-21 14:57:5315 [-c name=value]
Junio C Hamanod526ba92007-07-02 00:17:4216 [--help] COMMAND [ARGS]
Junio C Hamano1a4e8412005-12-27 08:17:2317
18DESCRIPTION
19-----------
Junio C Hamanoe27fb932006-04-03 05:34:1020Git is a fast, scalable, distributed revision control system with an
21unusually rich command set that provides both high-level operations
22and full access to internals.
23
Junio C Hamanofce7c7e2008-07-02 03:06:3824See linkgit:gittutorial[7] to get started, then see
Junio C Hamanoe27fb932006-04-03 05:34:1025link:everyday.html[Everyday Git] for a useful minimum set of commands, and
26"man git-commandname" for documentation of each command. CVS users may
Junio C Hamanofce7c7e2008-07-02 03:06:3827also want to read linkgit:gitcvs-migration[7]. See
28the link:user-manual.html[Git User's Manual] for a more in-depth
Junio C Hamano3d30fd52007-05-08 00:32:5329introduction.
Junio C Hamano1a4e8412005-12-27 08:17:2330
Junio C Hamano33db4372006-06-07 19:51:4531The COMMAND is either a name of a Git command (see below) or an alias
Junio C Hamano35738e82008-01-07 07:55:4632as defined in the configuration file (see linkgit:git-config[1]).
Junio C Hamano33db4372006-06-07 19:51:4533
Junio C Hamanob63afff2007-05-01 03:05:5534Formatted and hyperlinked version of the latest git
35documentation can be viewed at
36`http://www.kernel.org/pub/software/scm/git/docs/`.
37
Junio C Hamano9d52e572007-02-13 23:48:2038ifdef::stalenotes[]
39[NOTE]
40============
Junio C Hamano9d52e572007-02-13 23:48:2041
Junio C Hamanoa9b8d242007-05-19 04:51:5542You are reading the documentation for the latest (possibly
43unreleased) version of git, that is available from 'master'
44branch of the `git.git` repository.
45Documentation for older releases are available here:
Junio C Hamano2fc92602007-03-29 01:09:4646
Junio C Hamano08acb732010-07-21 21:58:3347* link:v1.7.2/git.html[documentation for release 1.7.2]
48
49* release notes for
50 link:RelNotes-1.7.2.txt[1.7.2].
51
Junio C Hamano7d449522010-07-01 00:08:5152* link:v1.7.1.1/git.html[documentation for release 1.7.1.1]
Junio C Hamanofc5d7352010-04-24 02:59:1153
54* release notes for
Junio C Hamano7d449522010-07-01 00:08:5155 link:RelNotes-1.7.1.1.txt[1.7.1.1],
Junio C Hamanofc5d7352010-04-24 02:59:1156 link:RelNotes-1.7.1.txt[1.7.1].
57
Junio C Hamanof703a392010-04-23 06:56:0258* link:v1.7.0.6/git.html[documentation for release 1.7.0.6]
Junio C Hamanodca34822010-02-13 01:02:5259
60* release notes for
Junio C Hamanof703a392010-04-23 06:56:0261 link:RelNotes-1.7.0.6.txt[1.7.0.6],
Junio C Hamano0e8c0b02010-04-12 15:45:5562 link:RelNotes-1.7.0.5.txt[1.7.0.5],
Junio C Hamano1f630d52010-04-01 04:49:2563 link:RelNotes-1.7.0.4.txt[1.7.0.4],
Junio C Hamano9ccf6642010-03-22 01:47:3564 link:RelNotes-1.7.0.3.txt[1.7.0.3],
Junio C Hamano636c8b22010-03-07 22:25:1765 link:RelNotes-1.7.0.2.txt[1.7.0.2],
Junio C Hamanobf433442010-02-28 23:13:3566 link:RelNotes-1.7.0.1.txt[1.7.0.1],
Junio C Hamanodca34822010-02-13 01:02:5267 link:RelNotes-1.7.0.txt[1.7.0].
68
Junio C Hamanoe7c7be32010-02-10 23:26:4869* link:v1.6.6.2/git.html[documentation for release 1.6.6.2]
Junio C Hamanof3a01ab2009-12-24 00:30:3470
71* release notes for
Junio C Hamanoe7c7be32010-02-10 23:26:4872 link:RelNotes-1.6.6.2.txt[1.6.6.2],
Junio C Hamanoa9701f02010-01-21 00:42:1673 link:RelNotes-1.6.6.1.txt[1.6.6.1],
Junio C Hamanof3a01ab2009-12-24 00:30:3474 link:RelNotes-1.6.6.txt[1.6.6].
75
Junio C Hamanoa9701f02010-01-21 00:42:1676* link:v1.6.5.8/git.html[documentation for release 1.6.5.8]
Junio C Hamano77e01e32009-10-11 01:57:3477
78* release notes for
Junio C Hamanoa9701f02010-01-21 00:42:1679 link:RelNotes-1.6.5.8.txt[1.6.5.8],
Junio C Hamano6a548ef2009-12-17 00:16:2080 link:RelNotes-1.6.5.7.txt[1.6.5.7],
Junio C Hamano93362772009-12-11 06:01:1181 link:RelNotes-1.6.5.6.txt[1.6.5.6],
Junio C Hamanoe5574b62009-12-06 04:04:4582 link:RelNotes-1.6.5.5.txt[1.6.5.5],
Junio C Hamanofa2ad882009-12-03 09:15:4483 link:RelNotes-1.6.5.4.txt[1.6.5.4],
Junio C Hamanoe26ca7c2009-11-16 22:28:3184 link:RelNotes-1.6.5.3.txt[1.6.5.3],
Junio C Hamano621e1232009-10-26 05:16:4785 link:RelNotes-1.6.5.2.txt[1.6.5.2],
Junio C Hamanob71a22d2009-10-17 08:23:4786 link:RelNotes-1.6.5.1.txt[1.6.5.1],
Junio C Hamano77e01e32009-10-11 01:57:3487 link:RelNotes-1.6.5.txt[1.6.5].
88
Junio C Hamanofb44f812009-09-17 00:40:1789* link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
Junio C Hamano3bd4ce32009-06-04 07:18:0990
91* release notes for
Junio C Hamanofb44f812009-09-17 00:40:1792 link:RelNotes-1.6.4.4.txt[1.6.4.4],
Junio C Hamano7df6dcf2009-09-13 09:51:1793 link:RelNotes-1.6.4.3.txt[1.6.4.3],
Junio C Hamano68cfa3a2009-08-30 00:22:5594 link:RelNotes-1.6.4.2.txt[1.6.4.2],
Junio C Hamanofe24db02009-08-22 05:10:4795 link:RelNotes-1.6.4.1.txt[1.6.4.1],
Junio C Hamano543f8d62009-07-29 08:35:2196 link:RelNotes-1.6.4.txt[1.6.4].
97
98* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
99
100* release notes for
101 link:RelNotes-1.6.3.4.txt[1.6.3.4],
Junio C Hamanod848f832009-06-22 08:15:12102 link:RelNotes-1.6.3.3.txt[1.6.3.3],
Junio C Hamano3bd4ce32009-06-04 07:18:09103 link:RelNotes-1.6.3.2.txt[1.6.3.2],
104 link:RelNotes-1.6.3.1.txt[1.6.3.1],
105 link:RelNotes-1.6.3.txt[1.6.3].
Junio C Hamanoa9eca4e2009-03-04 08:29:59106
107* release notes for
Junio C Hamanobde411d2009-05-07 05:07:31108 link:RelNotes-1.6.2.5.txt[1.6.2.5],
109 link:RelNotes-1.6.2.4.txt[1.6.2.4],
Junio C Hamano98e32c32009-04-13 02:39:53110 link:RelNotes-1.6.2.3.txt[1.6.2.3],
111 link:RelNotes-1.6.2.2.txt[1.6.2.2],
Junio C Hamano064b4ab2009-03-15 22:16:15112 link:RelNotes-1.6.2.1.txt[1.6.2.1],
Junio C Hamanoa9eca4e2009-03-04 08:29:59113 link:RelNotes-1.6.2.txt[1.6.2].
114
Junio C Hamanoe5bf6c12009-02-07 21:43:10115* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
Junio C Hamano13016de2008-12-25 05:46:57116
117* release notes for
Junio C Hamanoe5bf6c12009-02-07 21:43:10118 link:RelNotes-1.6.1.3.txt[1.6.1.3],
119 link:RelNotes-1.6.1.2.txt[1.6.1.2],
Junio C Hamano20d47e32009-01-26 06:36:02120 link:RelNotes-1.6.1.1.txt[1.6.1.1],
Junio C Hamano13016de2008-12-25 05:46:57121 link:RelNotes-1.6.1.txt[1.6.1].
122
Junio C Hamano54bf1e22008-12-20 06:30:11123* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
Junio C Hamanoc6e59502008-08-17 21:05:51124
125* release notes for
Junio C Hamano54bf1e22008-12-20 06:30:11126 link:RelNotes-1.6.0.6.txt[1.6.0.6],
Junio C Hamanob4028862008-12-08 02:03:49127 link:RelNotes-1.6.0.5.txt[1.6.0.5],
Junio C Hamano9bd39c42008-11-13 01:54:44128 link:RelNotes-1.6.0.4.txt[1.6.0.4],
129 link:RelNotes-1.6.0.3.txt[1.6.0.3],
Junio C Hamano675570c2008-09-13 06:07:28130 link:RelNotes-1.6.0.2.txt[1.6.0.2],
131 link:RelNotes-1.6.0.1.txt[1.6.0.1],
Junio C Hamanoc6e59502008-08-17 21:05:51132 link:RelNotes-1.6.0.txt[1.6.0].
133
Junio C Hamano54bf1e22008-12-20 06:30:11134* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
Junio C Hamano11fe55c2008-06-18 23:14:56135
136* release notes for
Junio C Hamano54bf1e22008-12-20 06:30:11137 link:RelNotes-1.5.6.6.txt[1.5.6.6],
Junio C Hamanob53db3c2008-08-07 00:17:52138 link:RelNotes-1.5.6.5.txt[1.5.6.5],
Junio C Hamano915cd9b2008-07-20 01:24:17139 link:RelNotes-1.5.6.4.txt[1.5.6.4],
140 link:RelNotes-1.5.6.3.txt[1.5.6.3],
141 link:RelNotes-1.5.6.2.txt[1.5.6.2],
142 link:RelNotes-1.5.6.1.txt[1.5.6.1],
Junio C Hamano9eb57532008-06-26 06:33:46143 link:RelNotes-1.5.6.txt[1.5.6].
Junio C Hamano11fe55c2008-06-18 23:14:56144
Junio C Hamano54bf1e22008-12-20 06:30:11145* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
Junio C Hamano0d0679d2008-04-08 06:15:46146
147* release notes for
Junio C Hamano54bf1e22008-12-20 06:30:11148 link:RelNotes-1.5.5.6.txt[1.5.5.6],
149 link:RelNotes-1.5.5.5.txt[1.5.5.5],
Junio C Hamanoe2b205c2008-06-08 01:43:44150 link:RelNotes-1.5.5.4.txt[1.5.5.4],
Junio C Hamano99b28f22008-05-28 08:07:26151 link:RelNotes-1.5.5.3.txt[1.5.5.3],
Junio C Hamanob7a77fa2008-05-26 07:20:01152 link:RelNotes-1.5.5.2.txt[1.5.5.2],
Junio C Hamanoe3ddb5b2008-04-21 00:48:07153 link:RelNotes-1.5.5.1.txt[1.5.5.1],
Junio C Hamano0d0679d2008-04-08 06:15:46154 link:RelNotes-1.5.5.txt[1.5.5].
155
Junio C Hamano54bf1e22008-12-20 06:30:11156* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
Junio C Hamano7b9b4262008-02-02 06:48:39157
158* release notes for
Junio C Hamano54bf1e22008-12-20 06:30:11159 link:RelNotes-1.5.4.7.txt[1.5.4.7],
160 link:RelNotes-1.5.4.6.txt[1.5.4.6],
Junio C Hamano56033be2008-03-28 06:12:53161 link:RelNotes-1.5.4.5.txt[1.5.4.5],
Junio C Hamanobb343172008-03-09 10:39:09162 link:RelNotes-1.5.4.4.txt[1.5.4.4],
Junio C Hamanocb174dd2008-02-23 21:03:54163 link:RelNotes-1.5.4.3.txt[1.5.4.3],
Junio C Hamanoe670d0d2008-02-17 20:14:59164 link:RelNotes-1.5.4.2.txt[1.5.4.2],
Junio C Hamanoefe3c632008-02-14 00:51:31165 link:RelNotes-1.5.4.1.txt[1.5.4.1],
Junio C Hamano7b9b4262008-02-02 06:48:39166 link:RelNotes-1.5.4.txt[1.5.4].
167
Junio C Hamano4e272312008-01-08 09:13:21168* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
Junio C Hamanoa75069c2007-09-04 01:19:24169
170* release notes for
Junio C Hamano4e272312008-01-08 09:13:21171 link:RelNotes-1.5.3.8.txt[1.5.3.8],
Junio C Hamano976c0c42007-12-01 21:57:14172 link:RelNotes-1.5.3.7.txt[1.5.3.7],
Junio C Hamanoe1258662007-11-19 05:03:19173 link:RelNotes-1.5.3.6.txt[1.5.3.6],
Junio C Hamano1c708832007-11-02 02:47:50174 link:RelNotes-1.5.3.5.txt[1.5.3.5],
Junio C Hamanoea719cf2007-10-04 13:06:35175 link:RelNotes-1.5.3.4.txt[1.5.3.4],
Junio C Hamano58992c92007-10-01 16:23:18176 link:RelNotes-1.5.3.3.txt[1.5.3.3],
Junio C Hamano199cdf12007-09-19 18:30:47177 link:RelNotes-1.5.3.2.txt[1.5.3.2],
Junio C Hamano61210dd2007-10-24 11:52:13178 link:RelNotes-1.5.3.1.txt[1.5.3.1],
179 link:RelNotes-1.5.3.txt[1.5.3].
Junio C Hamano75485c82007-05-19 04:20:33180
Junio C Hamano9eb57532008-06-26 06:33:46181* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
182
Junio C Hamanoed7f4f62007-05-20 09:09:09183* release notes for
Junio C Hamano3b178be2007-08-16 04:59:27184 link:RelNotes-1.5.2.5.txt[1.5.2.5],
Junio C Hamano235d53f2007-07-13 00:25:15185 link:RelNotes-1.5.2.4.txt[1.5.2.4],
Junio C Hamano1d90cb02007-07-03 07:05:31186 link:RelNotes-1.5.2.3.txt[1.5.2.3],
Junio C Hamano29b1b922007-06-16 16:30:26187 link:RelNotes-1.5.2.2.txt[1.5.2.2],
188 link:RelNotes-1.5.2.1.txt[1.5.2.1],
Junio C Hamanoed7f4f62007-05-20 09:09:09189 link:RelNotes-1.5.2.txt[1.5.2].
190
191* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
192
193* release notes for
194 link:RelNotes-1.5.1.6.txt[1.5.1.6],
195 link:RelNotes-1.5.1.5.txt[1.5.1.5],
Junio C Hamanoa9b8d242007-05-19 04:51:55196 link:RelNotes-1.5.1.4.txt[1.5.1.4],
197 link:RelNotes-1.5.1.3.txt[1.5.1.3],
198 link:RelNotes-1.5.1.2.txt[1.5.1.2],
199 link:RelNotes-1.5.1.1.txt[1.5.1.1],
200 link:RelNotes-1.5.1.txt[1.5.1].
Junio C Hamano91d44c52007-05-09 07:16:07201
Junio C Hamanoa9b8d242007-05-19 04:51:55202* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
Junio C Hamano91d44c52007-05-09 07:16:07203
Junio C Hamanoed7f4f62007-05-20 09:09:09204* release notes for
205 link:RelNotes-1.5.0.7.txt[1.5.0.7],
Junio C Hamanoa9b8d242007-05-19 04:51:55206 link:RelNotes-1.5.0.6.txt[1.5.0.6],
207 link:RelNotes-1.5.0.5.txt[1.5.0.5],
208 link:RelNotes-1.5.0.3.txt[1.5.0.3],
209 link:RelNotes-1.5.0.2.txt[1.5.0.2],
210 link:RelNotes-1.5.0.1.txt[1.5.0.1],
211 link:RelNotes-1.5.0.txt[1.5.0].
Junio C Hamanoe90436a2007-04-22 07:22:13212
Junio C Hamanoa9b8d242007-05-19 04:51:55213* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
214 link:v1.3.3/git.html[1.3.3],
215 link:v1.2.6/git.html[1.2.6],
216 link:v1.0.13/git.html[1.0.13].
Junio C Hamano9d52e572007-02-13 23:48:20217
218============
219
220endif::stalenotes[]
221
Junio C Hamano1a4e8412005-12-27 08:17:23222OPTIONS
223-------
224--version::
Junio C Hamano01078922006-03-10 00:31:47225Prints the git suite version that the 'git' program came from.
Junio C Hamano1a4e8412005-12-27 08:17:23226
227--help::
Junio C Hamano01078922006-03-10 00:31:47228Prints the synopsis and a list of the most commonly used
Junio C Hamano58256872007-12-04 08:31:13229commands. If the option '--all' or '-a' is given then all
230available commands are printed. If a git command is named this
231option will bring up the manual page for that command.
Junio C Hamano0c0da5f2007-12-13 02:45:30232+
233Other options are available to control how the manual page is
Junio C Hamano35738e82008-01-07 07:55:46234displayed. See linkgit:git-help[1] for more information,
Junio C Hamanoba4b9282008-07-06 05:20:31235because `git --help ...` is converted internally into `git
236help ...`.
Junio C Hamano1a4e8412005-12-27 08:17:23237
Junio C Hamanocc7636a2010-05-21 14:57:53238-c <name>=<value>::
239Pass a configuration parameter to the command. The value
240given will override values from configuration files.
241The <name> is expected in the same format as listed by
242'git config' (subkeys separated by dots).
243
Junio C Hamano1a4e8412005-12-27 08:17:23244--exec-path::
Junio C Hamano01078922006-03-10 00:31:47245Path to wherever your core git programs are installed.
Junio C Hamano1a4e8412005-12-27 08:17:23246This can also be controlled by setting the GIT_EXEC_PATH
Junio C Hamanoba4b9282008-07-06 05:20:31247environment variable. If no path is given, 'git' will print
Junio C Hamano1a4e8412005-12-27 08:17:23248the current setting and then exit.
249
Junio C Hamanob4a9ede2009-04-08 07:36:32250--html-path::
251Print the path to wherever your git HTML documentation is installed
252and exit.
253
Junio C Hamanoeb415992008-06-08 22:49:47254-p::
255--paginate::
Junio C Hamano4aa0bcc2010-03-03 05:13:12256Pipe all output into 'less' (or if set, $PAGER) if standard
257output is a terminal. This overrides the `pager.<cmd>`
258configuration options (see the "Configuration Mechanism" section
259below).
Junio C Hamanof870ef82006-07-29 09:10:13260
Junio C Hamanocae86272007-08-21 02:20:49261--no-pager::
262Do not pipe git output into a pager.
263
Junio C Hamanof870ef82006-07-29 09:10:13264--git-dir=<path>::
265Set the path to the repository. This can also be controlled by
Junio C Hamano7d575a52008-04-30 08:45:27266setting the GIT_DIR environment variable. It can be an absolute
267path or relative path to current working directory.
Junio C Hamanof870ef82006-07-29 09:10:13268
Junio C Hamanod526ba92007-07-02 00:17:42269--work-tree=<path>::
270Set the path to the working tree. The value will not be
271used in combination with repositories found automatically in
272a .git directory (i.e. $GIT_DIR is not set).
273This can also be controlled by setting the GIT_WORK_TREE
274environment variable and the core.worktree configuration
Junio C Hamano7d575a52008-04-30 08:45:27275variable. It can be an absolute path or relative path to
276the directory specified by --git-dir or GIT_DIR.
277Note: If --git-dir or GIT_DIR are specified but none of
278--work-tree, GIT_WORK_TREE and core.worktree is specified,
279the current working directory is regarded as the top directory
280of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42281
Junio C Hamanof870ef82006-07-29 09:10:13282--bare::
Junio C Hamanoc435b1c2007-08-28 06:25:35283Treat the repository as a bare repository. If GIT_DIR
284environment is not set, it is set to the current working
285directory.
286
Junio C Hamano3d23a0a2009-10-19 08:04:30287--no-replace-objects::
288Do not use replacement refs to replace git objects. See
289linkgit:git-replace[1] for more information.
290
Junio C Hamano1a4e8412005-12-27 08:17:23291
Junio C Hamanoe27fb932006-04-03 05:34:10292FURTHER DOCUMENTATION
293---------------------
Junio C Hamano1a4e8412005-12-27 08:17:23294
Junio C Hamanoe27fb932006-04-03 05:34:10295See the references above to get started using git. The following is
296probably more detail than necessary for a first-time user.
Junio C Hamano1a4e8412005-12-27 08:17:23297
Junio C Hamano597ffcf2007-09-17 17:33:15298The link:user-manual.html#git-concepts[git concepts chapter of the
Junio C Hamanofce7c7e2008-07-02 03:06:38299user-manual] and linkgit:gitcore-tutorial[7] both provide
Junio C Hamano597ffcf2007-09-17 17:33:15300introductions to the underlying git architecture.
Junio C Hamano1a4e8412005-12-27 08:17:23301
Junio C Hamano804b5212009-06-07 16:05:03302See linkgit:gitworkflows[7] for an overview of recommended workflows.
303
Junio C Hamanoe27fb932006-04-03 05:34:10304See also the link:howto-index.html[howto] documents for some useful
305examples.
Junio C Hamano1a4e8412005-12-27 08:17:23306
Junio C Hamanofce7c7e2008-07-02 03:06:38307The internals are documented in the
308link:technical/api-index.html[GIT API documentation].
Junio C Hamano3dac5042007-12-15 08:40:54309
Junio C Hamanoe27fb932006-04-03 05:34:10310GIT COMMANDS
311------------
Junio C Hamano1a4e8412005-12-27 08:17:23312
Junio C Hamanoe27fb932006-04-03 05:34:10313We divide git into high level ("porcelain") commands and low level
314("plumbing") commands.
Junio C Hamano1a4e8412005-12-27 08:17:23315
Junio C Hamanob19b4f02006-10-29 20:47:22316High-level commands (porcelain)
317-------------------------------
318
319We separate the porcelain commands into the main commands and some
320ancillary user utilities.
321
322Main porcelain commands
323~~~~~~~~~~~~~~~~~~~~~~~
324
Junio C Hamano7c73c662007-01-19 00:37:50325include::cmds-mainporcelain.txt[]
Junio C Hamanob19b4f02006-10-29 20:47:22326
327Ancillary Commands
328~~~~~~~~~~~~~~~~~~
329Manipulators:
330
Junio C Hamano7c73c662007-01-19 00:37:50331include::cmds-ancillarymanipulators.txt[]
Junio C Hamanob19b4f02006-10-29 20:47:22332
333Interrogators:
334
Junio C Hamano7c73c662007-01-19 00:37:50335include::cmds-ancillaryinterrogators.txt[]
Junio C Hamanob19b4f02006-10-29 20:47:22336
Junio C Hamano4ad294b2007-01-20 02:22:50337
338Interacting with Others
339~~~~~~~~~~~~~~~~~~~~~~~
340
341These commands are to interact with foreign SCM and with other
342people via patch over e-mail.
343
344include::cmds-foreignscminterface.txt[]
345
346
Junio C Hamanoe27fb932006-04-03 05:34:10347Low-level commands (plumbing)
348-----------------------------
Junio C Hamano1a4e8412005-12-27 08:17:23349
Junio C Hamanoe27fb932006-04-03 05:34:10350Although git includes its
351own porcelain layer, its low-level commands are sufficient to support
352development of alternative porcelains. Developers of such porcelains
Junio C Hamano35738e82008-01-07 07:55:46353might start by reading about linkgit:git-update-index[1] and
354linkgit:git-read-tree[1].
Junio C Hamano1a4e8412005-12-27 08:17:23355
Junio C Hamano4ad294b2007-01-20 02:22:50356The interface (input, output, set of options and the semantics)
357to these low-level commands are meant to be a lot more stable
358than Porcelain level commands, because these commands are
359primarily for scripted use. The interface to Porcelain commands
360on the other hand are subject to change in order to improve the
361end user experience.
362
363The following description divides
364the low-level commands into commands that manipulate objects (in
Junio C Hamanoe27fb932006-04-03 05:34:10365the repository, index, and working tree), commands that interrogate and
366compare objects, and commands that move objects and references between
367repositories.
Junio C Hamano1a4e8412005-12-27 08:17:23368
Junio C Hamano4ad294b2007-01-20 02:22:50369
Junio C Hamano1a4e8412005-12-27 08:17:23370Manipulation commands
371~~~~~~~~~~~~~~~~~~~~~
Junio C Hamano1a4e8412005-12-27 08:17:23372
Junio C Hamano7c73c662007-01-19 00:37:50373include::cmds-plumbingmanipulators.txt[]
Junio C Hamano1a4e8412005-12-27 08:17:23374
375
376Interrogation commands
377~~~~~~~~~~~~~~~~~~~~~~
378
Junio C Hamano7c73c662007-01-19 00:37:50379include::cmds-plumbinginterrogators.txt[]
Junio C Hamano1a4e8412005-12-27 08:17:23380
381In general, the interrogate commands do not touch the files in
382the working tree.
383
384
385Synching repositories
386~~~~~~~~~~~~~~~~~~~~~
387
Junio C Hamano7c73c662007-01-19 00:37:50388include::cmds-synchingrepositories.txt[]
Junio C Hamano1a4e8412005-12-27 08:17:23389
Junio C Hamano27a128b2009-08-13 01:23:00390The following are helper commands used by the above; end users
Junio C Hamano4ad294b2007-01-20 02:22:50391typically do not use them directly.
392
393include::cmds-synchelpers.txt[]
394
395
396Internal helper commands
397~~~~~~~~~~~~~~~~~~~~~~~~
398
399These are internal helper commands used by other commands; end
400users typically do not use them directly.
401
402include::cmds-purehelpers.txt[]
403
Junio C Hamano1a4e8412005-12-27 08:17:23404
Junio C Hamano1a4e8412005-12-27 08:17:23405Configuration Mechanism
406-----------------------
407
408Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
409is used to hold per-repository configuration options. It is a
Junio C Hamano51c2ab02006-07-09 20:38:54410simple text file modeled after `.ini` format familiar to some
Junio C Hamano1a4e8412005-12-27 08:17:23411people. Here is an example:
412
413------------
414#
415# A '#' or ';' character indicates a comment.
416#
417
418; core variables
419[core]
420; Don't trust file modes
421filemode = false
422
423; user identity
424[user]
425name = "Junio C Hamano"
426email = "junkio@twinsun.com"
427
428------------
429
430Various commands read from the configuration file and adjust
Junio C Hamano4aa0bcc2010-03-03 05:13:12431their operation accordingly. See linkgit:git-config[1] for a
432list.
Junio C Hamano1a4e8412005-12-27 08:17:23433
434
435Identifier Terminology
436----------------------
437<object>::
438Indicates the object name for any type of object.
439
440<blob>::
441Indicates a blob object name.
442
443<tree>::
444Indicates a tree object name.
445
446<commit>::
447Indicates a commit object name.
448
449<tree-ish>::
450Indicates a tree, commit or tag object name. A
451command that takes a <tree-ish> argument ultimately wants to
452operate on a <tree> object but automatically dereferences
453<commit> and <tag> objects that point at a <tree>.
454
Junio C Hamano60f8aa82007-03-06 09:58:26455<commit-ish>::
456Indicates a commit or tag object name. A
457command that takes a <commit-ish> argument ultimately wants to
458operate on a <commit> object but automatically dereferences
459<tag> objects that point at a <commit>.
460
Junio C Hamano1a4e8412005-12-27 08:17:23461<type>::
462Indicates that an object type is required.
463Currently one of: `blob`, `tree`, `commit`, or `tag`.
464
465<file>::
466Indicates a filename - almost always relative to the
467root of the tree structure `GIT_INDEX_FILE` describes.
468
469Symbolic Identifiers
470--------------------
471Any git command accepting any <object> can also use the following
472symbolic notation:
473
474HEAD::
475indicates the head of the current branch (i.e. the
476contents of `$GIT_DIR/HEAD`).
477
478<tag>::
479a valid tag 'name'
480(i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
481
482<head>::
483a valid head 'name'
484(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
485
Junio C Hamanoff4b4312006-10-25 22:55:31486For a more complete list of ways to spell object names, see
Junio C Hamano78e3a782010-07-15 22:24:45487"SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].
Junio C Hamanoff4b4312006-10-25 22:55:31488
Junio C Hamano1a4e8412005-12-27 08:17:23489
490File/Directory Structure
491------------------------
492
Junio C Hamanofce7c7e2008-07-02 03:06:38493Please see the linkgit:gitrepository-layout[5] document.
Junio C Hamano1a4e8412005-12-27 08:17:23494
Junio C Hamanofce7c7e2008-07-02 03:06:38495Read linkgit:githooks[5] for more details about each hook.
Junio C Hamano818f7d62006-03-26 01:49:30496
Junio C Hamano1a4e8412005-12-27 08:17:23497Higher level SCMs may provide and manage additional information in the
498`$GIT_DIR`.
499
500
501Terminology
502-----------
Junio C Hamanofce7c7e2008-07-02 03:06:38503Please see linkgit:gitglossary[7].
Junio C Hamano1a4e8412005-12-27 08:17:23504
505
506Environment Variables
507---------------------
508Various git commands use the following environment variables:
509
510The git Repository
511~~~~~~~~~~~~~~~~~~
512These environment variables apply to 'all' core git commands. Nb: it
513is worth noting that they may be used/overridden by SCMS sitting above
514git so take care if using Cogito etc.
515
516'GIT_INDEX_FILE'::
517This environment allows the specification of an alternate
518index file. If not specified, the default of `$GIT_DIR/index`
519is used.
520
521'GIT_OBJECT_DIRECTORY'::
522If the object storage directory is specified via this
523environment variable then the sha1 directories are created
524underneath - otherwise the default `$GIT_DIR/objects`
525directory is used.
526
527'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
528Due to the immutable nature of git objects, old objects can be
529archived into shared, read-only directories. This variable
Junio C Hamano05bf9c52008-07-03 09:21:58530specifies a ":" separated (on Windows ";" separated) list
531of git object directories which can be used to search for git
532objects. New objects will not be written to these directories.
Junio C Hamano1a4e8412005-12-27 08:17:23533
534'GIT_DIR'::
535If the 'GIT_DIR' environment variable is set then it
536specifies a path to use instead of the default `.git`
537for the base of the repository.
538
Junio C Hamanod526ba92007-07-02 00:17:42539'GIT_WORK_TREE'::
540Set the path to the working tree. The value will not be
541used in combination with repositories found automatically in
542a .git directory (i.e. $GIT_DIR is not set).
543This can also be controlled by the '--work-tree' command line
544option and the core.worktree configuration variable.
545
Junio C Hamano15048272008-07-07 22:10:48546'GIT_CEILING_DIRECTORIES'::
547This should be a colon-separated list of absolute paths.
548If set, it is a list of directories that git should not chdir
549up into while looking for a repository directory.
550It will not exclude the current working directory or
551a GIT_DIR set on the command line or in the environment.
552(Useful for excluding slow-loading network directories.)
553
Junio C Hamanocc7636a2010-05-21 14:57:53554'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
555When run in a directory that does not have ".git" repository
556directory, git tries to find such a directory in the parent
557directories to find the top of the working tree, but by default it
558does not cross filesystem boundaries. This environment variable
559can be set to true to tell git not to stop at filesystem
560boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
561an explicit repository directory set via 'GIT_DIR' or on the
562command line.
563
Junio C Hamano1a4e8412005-12-27 08:17:23564git Commits
565~~~~~~~~~~~
566'GIT_AUTHOR_NAME'::
567'GIT_AUTHOR_EMAIL'::
568'GIT_AUTHOR_DATE'::
569'GIT_COMMITTER_NAME'::
570'GIT_COMMITTER_EMAIL'::
Junio C Hamano469d60e2007-04-29 18:30:34571'GIT_COMMITTER_DATE'::
572'EMAIL'::
Junio C Hamano35738e82008-01-07 07:55:46573see linkgit:git-commit-tree[1]
Junio C Hamano1a4e8412005-12-27 08:17:23574
575git Diffs
576~~~~~~~~~
577'GIT_DIFF_OPTS'::
Junio C Hamano1c437122006-11-28 02:22:25578Only valid setting is "--unified=??" or "-u??" to set the
579number of context lines shown when a unified diff is created.
580This takes precedence over any "-U" or "--unified" option
581value passed on the git diff command line.
582
Junio C Hamano1a4e8412005-12-27 08:17:23583'GIT_EXTERNAL_DIFF'::
Junio C Hamano1c437122006-11-28 02:22:25584When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
585program named by it is called, instead of the diff invocation
586described above. For a path that is added, removed, or modified,
587 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
588
589path old-file old-hex old-mode new-file new-hex new-mode
590+
591where:
592
593<old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
594 contents of <old|new>,
595<old|new>-hex:: are the 40-hexdigit SHA1 hashes,
596<old|new>-mode:: are the octal representation of the file modes.
597
598+
599The file parameters can point at the user's working file
600(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
601when a new file is added), or a temporary file (e.g. `old-file` in the
602index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
603temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
604+
605For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
606parameter, <path>.
Junio C Hamano1a4e8412005-12-27 08:17:23607
Junio C Hamano7ccb9fd2006-07-15 01:38:40608other
609~~~~~
Junio C Hamano1e6e0062007-07-13 05:33:25610'GIT_MERGE_VERBOSITY'::
611A number controlling the amount of output shown by
612the recursive merge strategy. Overrides merge.verbosity.
Junio C Hamano35738e82008-01-07 07:55:46613See linkgit:git-merge[1]
Junio C Hamano1e6e0062007-07-13 05:33:25614
Junio C Hamano85e45fa2006-08-13 07:47:41615'GIT_PAGER'::
Junio C Hamanof6002a92007-07-20 10:28:22616This environment variable overrides `$PAGER`. If it is set
617to an empty string or to the value "cat", git will not launch
Junio C Hamano0551f6a2008-08-25 00:33:33618a pager. See also the `core.pager` option in
619linkgit:git-config[1].
Junio C Hamano85e45fa2006-08-13 07:47:41620
Junio C Hamano4cd1c0e2007-08-06 04:39:14621'GIT_SSH'::
Junio C Hamano1aa40d22010-01-21 17:46:43622If this environment variable is set then 'git fetch'
623and 'git push' will use this command instead
Junio C Hamanoba4b9282008-07-06 05:20:31624of 'ssh' when they need to connect to a remote system.
Junio C Hamanofce7c7e2008-07-02 03:06:38625The '$GIT_SSH' command will be given exactly two arguments:
Junio C Hamano4cd1c0e2007-08-06 04:39:14626the 'username@host' (or just 'host') from the URL and the
627shell command to execute on that remote system.
628+
629To pass options to the program that you want to list in GIT_SSH
630you will need to wrap the program and options into a shell script,
631then set GIT_SSH to refer to the shell script.
632+
633Usually it is easier to configure any desired options through your
634personal `.ssh/config` file. Please consult your ssh documentation
635for further details.
636
Junio C Hamano401939f2007-07-01 06:34:30637'GIT_FLUSH'::
638If this environment variable is set to "1", then commands such
Junio C Hamano1aa40d22010-01-21 17:46:43639as 'git blame' (in incremental mode), 'git rev-list', 'git log',
640and 'git whatchanged' will force a flush of the output stream
Junio C Hamano401939f2007-07-01 06:34:30641after each commit-oriented record have been flushed. If this
642variable is set to "0", the output of these commands will be done
643using completely buffered I/O. If this environment variable is
644not set, git will choose buffered or record-oriented flushing
645based on whether stdout appears to be redirected to a file or not.
646
Junio C Hamano7ccb9fd2006-07-15 01:38:40647'GIT_TRACE'::
Junio C Hamanoef4b48b2006-09-04 10:08:34648If this variable is set to "1", "2" or "true" (comparison
649is case insensitive), git will print `trace:` messages on
Junio C Hamano7ccb9fd2006-07-15 01:38:40650stderr telling about alias expansion, built-in command
651execution and external command execution.
Junio C Hamanoef4b48b2006-09-04 10:08:34652If this variable is set to an integer value greater than 1
653and lower than 10 (strictly) then git will interpret this
654value as an open file descriptor and will try to write the
655trace messages into this file descriptor.
656Alternatively, if this variable is set to an absolute path
657(starting with a '/' character), git will interpret this
658as a file path and will try to write the trace messages
659into it.
Junio C Hamano7ccb9fd2006-07-15 01:38:40660
Junio C Hamano1a4e8412005-12-27 08:17:23661Discussion[[Discussion]]
662------------------------
Junio C Hamano597ffcf2007-09-17 17:33:15663
664More detail on the following is available from the
665link:user-manual.html#git-concepts[git concepts chapter of the
Junio C Hamanofce7c7e2008-07-02 03:06:38666user-manual] and linkgit:gitcore-tutorial[7].
Junio C Hamano597ffcf2007-09-17 17:33:15667
668A git project normally consists of a working directory with a ".git"
669subdirectory at the top level. The .git directory contains, among other
670things, a compressed object database representing the complete history
671of the project, an "index" file which links that history to the current
672contents of the working tree, and named pointers into that history such
673as tags and branch heads.
674
675The object database contains objects of three main types: blobs, which
676hold file data; trees, which point to blobs and other trees to build up
Junio C Hamanofe986052007-12-19 07:33:38677directory hierarchies; and commits, which each reference a single tree
Junio C Hamano597ffcf2007-09-17 17:33:15678and some number of parent commits.
679
680The commit, equivalent to what other systems call a "changeset" or
681"version", represents a step in the project's history, and each parent
682represents an immediately preceding step. Commits with more than one
683parent represent merges of independent lines of development.
684
685All objects are named by the SHA1 hash of their contents, normally
686written as a string of 40 hex digits. Such names are globally unique.
687The entire history leading up to a commit can be vouched for by signing
688just that commit. A fourth object type, the tag, is provided for this
689purpose.
690
691When first created, objects are stored in individual files, but for
692efficiency may later be compressed together into "pack files".
693
694Named pointers called refs mark interesting points in history. A ref
695may contain the SHA1 name of an object or the name of another ref. Refs
696with names beginning `ref/head/` contain the SHA1 name of the most
Junio C Hamanofe986052007-12-19 07:33:38697recent commit (or "head") of a branch under development. SHA1 names of
Junio C Hamano597ffcf2007-09-17 17:33:15698tags of interest are stored under `ref/tags/`. A special ref named
699`HEAD` contains the name of the currently checked-out branch.
700
701The index file is initialized with a list of all paths and, for each
702path, a blob object and a set of attributes. The blob object represents
703the contents of the file as of the head of the current branch. The
704attributes (last modified time, size, etc.) are taken from the
705corresponding file in the working tree. Subsequent changes to the
706working tree can be found by comparing these attributes. The index may
707be updated with new content, and new commits may be created from the
708content stored in the index.
709
710The index is also capable of storing multiple entries (called "stages")
711for a given pathname. These stages are used to hold the various
712unmerged version of a file when a merge is in progress.
Junio C Hamano1a4e8412005-12-27 08:17:23713
714Authors
715-------
716* git's founding father is Linus Torvalds <torvalds@osdl.org>.
Junio C Hamanodbb64592007-09-01 11:17:39717* The current git nurse is Junio C Hamano <gitster@pobox.com>.
Junio C Hamanoe0facb92007-12-05 10:59:48718* The git potty was written by Andreas Ericsson <ae@op5.se>.
Junio C Hamano1a4e8412005-12-27 08:17:23719* General upbringing is handled by the git-list <git@vger.kernel.org>.
720
721Documentation
722--------------
723The documentation for git suite was started by David Greaves
724<david@dgreaves.com>, and later enhanced greatly by the
725contributors on the git-list <git@vger.kernel.org>.
726
Junio C Hamano9e1793f2008-06-02 07:31:16727SEE ALSO
728--------
729linkgit:gittutorial[7], linkgit:gittutorial-2[7],
Junio C Hamanoaf1987f2008-08-03 07:58:19730link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
Junio C Hamano9e1793f2008-06-02 07:31:16731linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
Junio C Hamano804b5212009-06-07 16:05:03732linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
733linkgit:gitworkflows[7]
Junio C Hamano9e1793f2008-06-02 07:31:16734
Junio C Hamano1a4e8412005-12-27 08:17:23735GIT
736---
Junio C Hamanof7c042d2008-06-06 22:50:53737Part of the linkgit:git[1] suite