git.txt 27.6 KB
Newer Older
1
git(1)
2 3 4 5 6 7 8 9 10
======

NAME
----
git - the stupid content tracker


SYNOPSIS
--------
11
[verse]
12 13
'git' [--version] [--help] [-c <name>=<value>]
    [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
J
Josh Triplett 已提交
14 15
    [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
    [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
16
    <command> [<args>]
17 18 19

DESCRIPTION
-----------
20 21 22 23
Git is a fast, scalable, distributed revision control system with an
unusually rich command set that provides both high-level operations
and full access to internals.

24
See linkgit:gittutorial[7] to get started, then see
25 26
link:everyday.html[Everyday Git] for a useful minimum set of commands, and
"man git-commandname" for documentation of each command.  CVS users may
27 28
also want to read linkgit:gitcvs-migration[7].  See
the link:user-manual.html[Git User's Manual] for a more in-depth
29
introduction.
30

31
The '<command>' is either a name of a Git command (see below) or an alias
32
as defined in the configuration file (see linkgit:git-config[1]).
P
Petr Baudis 已提交
33

34 35
Formatted and hyperlinked version of the latest git
documentation can be viewed at
36
`http://git-htmldocs.googlecode.com/git/git.html`.
37

38 39 40 41
ifdef::stalenotes[]
[NOTE]
============

42 43 44 45
You are reading the documentation for the latest (possibly
unreleased) version of git, that is available from 'master'
branch of the `git.git` repository.
Documentation for older releases are available here:
46

J
Junio C Hamano 已提交
47
* link:v1.7.11.5/git.html[documentation for release 1.7.11.5]
J
Junio C Hamano 已提交
48 49

* release notes for
J
Junio C Hamano 已提交
50
  link:RelNotes/1.7.11.5.txt[1.7.11.5],
J
Junio C Hamano 已提交
51
  link:RelNotes/1.7.11.4.txt[1.7.11.4],
J
Junio C Hamano 已提交
52
  link:RelNotes/1.7.11.3.txt[1.7.11.3],
J
Junio C Hamano 已提交
53
  link:RelNotes/1.7.11.2.txt[1.7.11.2],
J
Junio C Hamano 已提交
54
  link:RelNotes/1.7.11.1.txt[1.7.11.1],
J
Junio C Hamano 已提交
55 56
  link:RelNotes/1.7.11.txt[1.7.11].

J
Junio C Hamano 已提交
57
* link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
J
Junio C Hamano 已提交
58 59

* release notes for
J
Junio C Hamano 已提交
60
  link:RelNotes/1.7.10.5.txt[1.7.10.5],
J
Junio C Hamano 已提交
61
  link:RelNotes/1.7.10.4.txt[1.7.10.4],
J
Junio C Hamano 已提交
62
  link:RelNotes/1.7.10.3.txt[1.7.10.3],
J
Junio C Hamano 已提交
63
  link:RelNotes/1.7.10.2.txt[1.7.10.2],
J
Junio C Hamano 已提交
64
  link:RelNotes/1.7.10.1.txt[1.7.10.1],
J
Junio C Hamano 已提交
65 66
  link:RelNotes/1.7.10.txt[1.7.10].

J
Junio C Hamano 已提交
67
* link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
J
Junio C Hamano 已提交
68 69

* release notes for
J
Junio C Hamano 已提交
70
  link:RelNotes/1.7.9.7.txt[1.7.9.7],
J
Junio C Hamano 已提交
71
  link:RelNotes/1.7.9.6.txt[1.7.9.6],
J
Junio C Hamano 已提交
72
  link:RelNotes/1.7.9.5.txt[1.7.9.5],
J
Junio C Hamano 已提交
73
  link:RelNotes/1.7.9.4.txt[1.7.9.4],
J
Junio C Hamano 已提交
74
  link:RelNotes/1.7.9.3.txt[1.7.9.3],
J
Junio C Hamano 已提交
75
  link:RelNotes/1.7.9.2.txt[1.7.9.2],
J
Junio C Hamano 已提交
76
  link:RelNotes/1.7.9.1.txt[1.7.9.1],
J
Junio C Hamano 已提交
77 78
  link:RelNotes/1.7.9.txt[1.7.9].

J
Junio C Hamano 已提交
79
* link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
J
Junio C Hamano 已提交
80 81

* release notes for
J
Junio C Hamano 已提交
82
  link:RelNotes/1.7.8.6.txt[1.7.8.6],
J
Junio C Hamano 已提交
83
  link:RelNotes/1.7.8.5.txt[1.7.8.5],
J
Junio C Hamano 已提交
84
  link:RelNotes/1.7.8.4.txt[1.7.8.4],
J
Junio C Hamano 已提交
85 86 87
  link:RelNotes/1.7.8.3.txt[1.7.8.3],
  link:RelNotes/1.7.8.2.txt[1.7.8.2],
  link:RelNotes/1.7.8.1.txt[1.7.8.1],
J
Junio C Hamano 已提交
88 89
  link:RelNotes/1.7.8.txt[1.7.8].

J
Junio C Hamano 已提交
90
* link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
J
Junio C Hamano 已提交
91 92

* release notes for
J
Junio C Hamano 已提交
93
  link:RelNotes/1.7.7.7.txt[1.7.7.7],
J
Junio C Hamano 已提交
94
  link:RelNotes/1.7.7.6.txt[1.7.7.6],
J
Junio C Hamano 已提交
95 96 97 98
  link:RelNotes/1.7.7.5.txt[1.7.7.5],
  link:RelNotes/1.7.7.4.txt[1.7.7.4],
  link:RelNotes/1.7.7.3.txt[1.7.7.3],
  link:RelNotes/1.7.7.2.txt[1.7.7.2],
J
Junio C Hamano 已提交
99
  link:RelNotes/1.7.7.1.txt[1.7.7.1],
J
Junio C Hamano 已提交
100 101
  link:RelNotes/1.7.7.txt[1.7.7].

J
Junio C Hamano 已提交
102
* link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
J
Junio C Hamano 已提交
103 104

* release notes for
J
Junio C Hamano 已提交
105
  link:RelNotes/1.7.6.6.txt[1.7.6.6],
J
Junio C Hamano 已提交
106
  link:RelNotes/1.7.6.5.txt[1.7.6.5],
J
Junio C Hamano 已提交
107
  link:RelNotes/1.7.6.4.txt[1.7.6.4],
J
Junio C Hamano 已提交
108
  link:RelNotes/1.7.6.3.txt[1.7.6.3],
J
Junio C Hamano 已提交
109 110
  link:RelNotes/1.7.6.2.txt[1.7.6.2],
  link:RelNotes/1.7.6.1.txt[1.7.6.1],
J
Junio C Hamano 已提交
111 112
  link:RelNotes/1.7.6.txt[1.7.6].

J
Junio C Hamano 已提交
113
* link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
J
Junio C Hamano 已提交
114 115

* release notes for
J
Junio C Hamano 已提交
116
  link:RelNotes/1.7.5.4.txt[1.7.5.4],
J
Junio C Hamano 已提交
117
  link:RelNotes/1.7.5.3.txt[1.7.5.3],
J
Junio C Hamano 已提交
118
  link:RelNotes/1.7.5.2.txt[1.7.5.2],
J
Junio C Hamano 已提交
119
  link:RelNotes/1.7.5.1.txt[1.7.5.1],
J
Junio C Hamano 已提交
120 121
  link:RelNotes/1.7.5.txt[1.7.5].

J
Junio C Hamano 已提交
122
* link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
J
Junio C Hamano 已提交
123 124

* release notes for
J
Junio C Hamano 已提交
125
  link:RelNotes/1.7.4.5.txt[1.7.4.5],
J
Junio C Hamano 已提交
126
  link:RelNotes/1.7.4.4.txt[1.7.4.4],
J
Junio C Hamano 已提交
127 128
  link:RelNotes/1.7.4.3.txt[1.7.4.3],
  link:RelNotes/1.7.4.2.txt[1.7.4.2],
J
Junio C Hamano 已提交
129
  link:RelNotes/1.7.4.1.txt[1.7.4.1],
J
Junio C Hamano 已提交
130 131
  link:RelNotes/1.7.4.txt[1.7.4].

J
Junio C Hamano 已提交
132
* link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
J
Junio C Hamano 已提交
133 134

* release notes for
J
Junio C Hamano 已提交
135
  link:RelNotes/1.7.3.5.txt[1.7.3.5],
J
Junio C Hamano 已提交
136
  link:RelNotes/1.7.3.4.txt[1.7.3.4],
137
  link:RelNotes/1.7.3.3.txt[1.7.3.3],
J
Junio C Hamano 已提交
138
  link:RelNotes/1.7.3.2.txt[1.7.3.2],
J
Junio C Hamano 已提交
139
  link:RelNotes/1.7.3.1.txt[1.7.3.1],
J
Junio C Hamano 已提交
140 141
  link:RelNotes/1.7.3.txt[1.7.3].

142
* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
J
Junio C Hamano 已提交
143 144

* release notes for
145
  link:RelNotes/1.7.2.5.txt[1.7.2.5],
146
  link:RelNotes/1.7.2.4.txt[1.7.2.4],
147 148 149 150
  link:RelNotes/1.7.2.3.txt[1.7.2.3],
  link:RelNotes/1.7.2.2.txt[1.7.2.2],
  link:RelNotes/1.7.2.1.txt[1.7.2.1],
  link:RelNotes/1.7.2.txt[1.7.2].
J
Junio C Hamano 已提交
151

152
* link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
J
Junio C Hamano 已提交
153 154

* release notes for
155
  link:RelNotes/1.7.1.4.txt[1.7.1.4],
156
  link:RelNotes/1.7.1.3.txt[1.7.1.3],
157 158 159
  link:RelNotes/1.7.1.2.txt[1.7.1.2],
  link:RelNotes/1.7.1.1.txt[1.7.1.1],
  link:RelNotes/1.7.1.txt[1.7.1].
J
Junio C Hamano 已提交
160

161
* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
J
Junio C Hamano 已提交
162 163

* release notes for
164
  link:RelNotes/1.7.0.9.txt[1.7.0.9],
165
  link:RelNotes/1.7.0.8.txt[1.7.0.8],
166 167 168 169 170 171 172 173
  link:RelNotes/1.7.0.7.txt[1.7.0.7],
  link:RelNotes/1.7.0.6.txt[1.7.0.6],
  link:RelNotes/1.7.0.5.txt[1.7.0.5],
  link:RelNotes/1.7.0.4.txt[1.7.0.4],
  link:RelNotes/1.7.0.3.txt[1.7.0.3],
  link:RelNotes/1.7.0.2.txt[1.7.0.2],
  link:RelNotes/1.7.0.1.txt[1.7.0.1],
  link:RelNotes/1.7.0.txt[1.7.0].
J
Junio C Hamano 已提交
174

175
* link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
J
Junio C Hamano 已提交
176 177

* release notes for
178
  link:RelNotes/1.6.6.3.txt[1.6.6.3],
179 180 181
  link:RelNotes/1.6.6.2.txt[1.6.6.2],
  link:RelNotes/1.6.6.1.txt[1.6.6.1],
  link:RelNotes/1.6.6.txt[1.6.6].
J
Junio C Hamano 已提交
182

183
* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
J
Junio C Hamano 已提交
184 185

* release notes for
186
  link:RelNotes/1.6.5.9.txt[1.6.5.9],
187 188 189 190 191 192 193 194 195
  link:RelNotes/1.6.5.8.txt[1.6.5.8],
  link:RelNotes/1.6.5.7.txt[1.6.5.7],
  link:RelNotes/1.6.5.6.txt[1.6.5.6],
  link:RelNotes/1.6.5.5.txt[1.6.5.5],
  link:RelNotes/1.6.5.4.txt[1.6.5.4],
  link:RelNotes/1.6.5.3.txt[1.6.5.3],
  link:RelNotes/1.6.5.2.txt[1.6.5.2],
  link:RelNotes/1.6.5.1.txt[1.6.5.1],
  link:RelNotes/1.6.5.txt[1.6.5].
J
Junio C Hamano 已提交
196

197
* link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
J
Junio C Hamano 已提交
198 199

* release notes for
200
  link:RelNotes/1.6.4.5.txt[1.6.4.5],
201 202 203 204 205
  link:RelNotes/1.6.4.4.txt[1.6.4.4],
  link:RelNotes/1.6.4.3.txt[1.6.4.3],
  link:RelNotes/1.6.4.2.txt[1.6.4.2],
  link:RelNotes/1.6.4.1.txt[1.6.4.1],
  link:RelNotes/1.6.4.txt[1.6.4].
J
Junio C Hamano 已提交
206

J
Junio C Hamano 已提交
207
* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
208 209

* release notes for
210 211 212 213 214
  link:RelNotes/1.6.3.4.txt[1.6.3.4],
  link:RelNotes/1.6.3.3.txt[1.6.3.3],
  link:RelNotes/1.6.3.2.txt[1.6.3.2],
  link:RelNotes/1.6.3.1.txt[1.6.3.1],
  link:RelNotes/1.6.3.txt[1.6.3].
J
Junio C Hamano 已提交
215 216

* release notes for
217 218 219 220 221 222
  link:RelNotes/1.6.2.5.txt[1.6.2.5],
  link:RelNotes/1.6.2.4.txt[1.6.2.4],
  link:RelNotes/1.6.2.3.txt[1.6.2.3],
  link:RelNotes/1.6.2.2.txt[1.6.2.2],
  link:RelNotes/1.6.2.1.txt[1.6.2.1],
  link:RelNotes/1.6.2.txt[1.6.2].
J
Junio C Hamano 已提交
223

J
Junio C Hamano 已提交
224
* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
J
Junio C Hamano 已提交
225 226

* release notes for
227 228 229 230
  link:RelNotes/1.6.1.3.txt[1.6.1.3],
  link:RelNotes/1.6.1.2.txt[1.6.1.2],
  link:RelNotes/1.6.1.1.txt[1.6.1.1],
  link:RelNotes/1.6.1.txt[1.6.1].
J
Junio C Hamano 已提交
231

232
* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
J
Junio C Hamano 已提交
233 234

* release notes for
235 236 237 238 239 240 241
  link:RelNotes/1.6.0.6.txt[1.6.0.6],
  link:RelNotes/1.6.0.5.txt[1.6.0.5],
  link:RelNotes/1.6.0.4.txt[1.6.0.4],
  link:RelNotes/1.6.0.3.txt[1.6.0.3],
  link:RelNotes/1.6.0.2.txt[1.6.0.2],
  link:RelNotes/1.6.0.1.txt[1.6.0.1],
  link:RelNotes/1.6.0.txt[1.6.0].
J
Junio C Hamano 已提交
242

243
* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
J
Junio C Hamano 已提交
244 245

* release notes for
246 247 248 249 250 251 252
  link:RelNotes/1.5.6.6.txt[1.5.6.6],
  link:RelNotes/1.5.6.5.txt[1.5.6.5],
  link:RelNotes/1.5.6.4.txt[1.5.6.4],
  link:RelNotes/1.5.6.3.txt[1.5.6.3],
  link:RelNotes/1.5.6.2.txt[1.5.6.2],
  link:RelNotes/1.5.6.1.txt[1.5.6.1],
  link:RelNotes/1.5.6.txt[1.5.6].
J
Junio C Hamano 已提交
253

254
* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
J
Junio C Hamano 已提交
255 256

* release notes for
257 258 259 260 261 262 263
  link:RelNotes/1.5.5.6.txt[1.5.5.6],
  link:RelNotes/1.5.5.5.txt[1.5.5.5],
  link:RelNotes/1.5.5.4.txt[1.5.5.4],
  link:RelNotes/1.5.5.3.txt[1.5.5.3],
  link:RelNotes/1.5.5.2.txt[1.5.5.2],
  link:RelNotes/1.5.5.1.txt[1.5.5.1],
  link:RelNotes/1.5.5.txt[1.5.5].
J
Junio C Hamano 已提交
264

265
* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
266 267

* release notes for
268 269 270 271 272 273 274 275
  link:RelNotes/1.5.4.7.txt[1.5.4.7],
  link:RelNotes/1.5.4.6.txt[1.5.4.6],
  link:RelNotes/1.5.4.5.txt[1.5.4.5],
  link:RelNotes/1.5.4.4.txt[1.5.4.4],
  link:RelNotes/1.5.4.3.txt[1.5.4.3],
  link:RelNotes/1.5.4.2.txt[1.5.4.2],
  link:RelNotes/1.5.4.1.txt[1.5.4.1],
  link:RelNotes/1.5.4.txt[1.5.4].
276

J
Junio C Hamano 已提交
277
* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
278 279

* release notes for
280 281 282 283 284 285 286 287 288
  link:RelNotes/1.5.3.8.txt[1.5.3.8],
  link:RelNotes/1.5.3.7.txt[1.5.3.7],
  link:RelNotes/1.5.3.6.txt[1.5.3.6],
  link:RelNotes/1.5.3.5.txt[1.5.3.5],
  link:RelNotes/1.5.3.4.txt[1.5.3.4],
  link:RelNotes/1.5.3.3.txt[1.5.3.3],
  link:RelNotes/1.5.3.2.txt[1.5.3.2],
  link:RelNotes/1.5.3.1.txt[1.5.3.1],
  link:RelNotes/1.5.3.txt[1.5.3].
289

J
Junio C Hamano 已提交
290 291
* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]

J
Junio C Hamano 已提交
292
* release notes for
293 294 295 296 297 298
  link:RelNotes/1.5.2.5.txt[1.5.2.5],
  link:RelNotes/1.5.2.4.txt[1.5.2.4],
  link:RelNotes/1.5.2.3.txt[1.5.2.3],
  link:RelNotes/1.5.2.2.txt[1.5.2.2],
  link:RelNotes/1.5.2.1.txt[1.5.2.1],
  link:RelNotes/1.5.2.txt[1.5.2].
J
Junio C Hamano 已提交
299 300 301 302

* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]

* release notes for
303 304 305 306 307 308 309
  link:RelNotes/1.5.1.6.txt[1.5.1.6],
  link:RelNotes/1.5.1.5.txt[1.5.1.5],
  link:RelNotes/1.5.1.4.txt[1.5.1.4],
  link:RelNotes/1.5.1.3.txt[1.5.1.3],
  link:RelNotes/1.5.1.2.txt[1.5.1.2],
  link:RelNotes/1.5.1.1.txt[1.5.1.1],
  link:RelNotes/1.5.1.txt[1.5.1].
310 311 312

* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]

J
Junio C Hamano 已提交
313
* release notes for
314 315 316 317 318 319 320
  link:RelNotes/1.5.0.7.txt[1.5.0.7],
  link:RelNotes/1.5.0.6.txt[1.5.0.6],
  link:RelNotes/1.5.0.5.txt[1.5.0.5],
  link:RelNotes/1.5.0.3.txt[1.5.0.3],
  link:RelNotes/1.5.0.2.txt[1.5.0.2],
  link:RelNotes/1.5.0.1.txt[1.5.0.1],
  link:RelNotes/1.5.0.txt[1.5.0].
321 322 323 324 325

* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
  link:v1.3.3/git.html[1.3.3],
  link:v1.2.6/git.html[1.2.6],
  link:v1.0.13/git.html[1.0.13].
326 327 328 329 330

============

endif::stalenotes[]

331 332 333
OPTIONS
-------
--version::
F
Fredrik Kuivinen 已提交
334
	Prints the git suite version that the 'git' program came from.
335 336

--help::
F
Fredrik Kuivinen 已提交
337
	Prints the synopsis and a list of the most commonly used
338 339 340
	commands. If the option '--all' or '-a' is given then all
	available commands are printed. If a git command is named this
	option will bring up the manual page for that command.
341 342
+
Other options are available to control how the manual page is
343
displayed. See linkgit:git-help[1] for more information,
344 345
because `git --help ...` is converted internally into `git
help ...`.
346

347 348 349 350 351 352
-c <name>=<value>::
	Pass a configuration parameter to the command. The value
	given will override values from configuration files.
	The <name> is expected in the same format as listed by
	'git config' (subkeys separated by dots).

353
--exec-path[=<path>]::
F
Fredrik Kuivinen 已提交
354
	Path to wherever your core git programs are installed.
355
	This can also be controlled by setting the GIT_EXEC_PATH
J
Jonathan Nieder 已提交
356
	environment variable. If no path is given, 'git' will print
357 358
	the current setting and then exit.

359
--html-path::
360 361
	Print the path, without trailing slash, where git's HTML
	documentation is installed and exit.
362

363
--man-path::
364 365
	Print the manpath (see `man(1)`) for the man pages for
	this version of git and exit.
366 367

--info-path::
368 369
	Print the path where the Info files documenting this
	version of git are installed and exit.
370

371 372
-p::
--paginate::
373 374 375 376
	Pipe all output into 'less' (or if set, $PAGER) if standard
	output is a terminal.  This overrides the `pager.<cmd>`
	configuration options (see the "Configuration Mechanism" section
	below).
377

378 379 380
--no-pager::
	Do not pipe git output into a pager.

381 382
--git-dir=<path>::
	Set the path to the repository. This can also be controlled by
383 384
	setting the GIT_DIR environment variable. It can be an absolute
	path or relative path to current working directory.
385

386
--work-tree=<path>::
387 388
	Set the path to the working tree. It can be an absolute path
	or a path relative to the current working directory.
389 390
	This can also be controlled by setting the GIT_WORK_TREE
	environment variable and the core.worktree configuration
391 392
	variable (see core.worktree in linkgit:git-config[1] for a
	more detailed discussion).
393

J
Josh Triplett 已提交
394 395 396 397 398
--namespace=<path>::
	Set the git namespace.  See linkgit:gitnamespaces[7] for more
	details.  Equivalent to setting the `GIT_NAMESPACE` environment
	variable.

399
--bare::
400 401 402 403
	Treat the repository as a bare repository.  If GIT_DIR
	environment is not set, it is set to the current working
	directory.

404 405 406 407
--no-replace-objects::
	Do not use replacement refs to replace git objects. See
	linkgit:git-replace[1] for more information.

408

409 410
FURTHER DOCUMENTATION
---------------------
411

412 413
See the references above to get started using git.  The following is
probably more detail than necessary for a first-time user.
J
Junio C Hamano 已提交
414

415
The link:user-manual.html#git-concepts[git concepts chapter of the
416
user-manual] and linkgit:gitcore-tutorial[7] both provide
417
introductions to the underlying git architecture.
418

419 420
See linkgit:gitworkflows[7] for an overview of recommended workflows.

421 422
See also the link:howto-index.html[howto] documents for some useful
examples.
423

424 425
The internals are documented in the
link:technical/api-index.html[GIT API documentation].
426

427 428
GIT COMMANDS
------------
429

430 431
We divide git into high level ("porcelain") commands and low level
("plumbing") commands.
432

433 434 435 436 437 438 439 440
High-level commands (porcelain)
-------------------------------

We separate the porcelain commands into the main commands and some
ancillary user utilities.

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
441

442
include::cmds-mainporcelain.txt[]
443

444
Ancillary Commands
445
~~~~~~~~~~~~~~~~~~
446 447
Manipulators:

448
include::cmds-ancillarymanipulators.txt[]
449

450
Interrogators:
451

452
include::cmds-ancillaryinterrogators.txt[]
453

454 455 456 457 458 459 460 461 462 463

Interacting with Others
~~~~~~~~~~~~~~~~~~~~~~~

These commands are to interact with foreign SCM and with other
people via patch over e-mail.

include::cmds-foreignscminterface.txt[]


464 465 466 467 468 469
Low-level commands (plumbing)
-----------------------------

Although git includes its
own porcelain layer, its low-level commands are sufficient to support
development of alternative porcelains.  Developers of such porcelains
470 471
might start by reading about linkgit:git-update-index[1] and
linkgit:git-read-tree[1].
472

473 474 475 476 477 478 479 480 481
The interface (input, output, set of options and the semantics)
to these low-level commands are meant to be a lot more stable
than Porcelain level commands, because these commands are
primarily for scripted use.  The interface to Porcelain commands
on the other hand are subject to change in order to improve the
end user experience.

The following description divides
the low-level commands into commands that manipulate objects (in
482 483 484 485
the repository, index, and working tree), commands that interrogate and
compare objects, and commands that move objects and references between
repositories.

486

487 488 489
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

490
include::cmds-plumbingmanipulators.txt[]
491 492 493 494 495


Interrogation commands
~~~~~~~~~~~~~~~~~~~~~~

496
include::cmds-plumbinginterrogators.txt[]
497 498 499 500 501 502 503 504

In general, the interrogate commands do not touch the files in
the working tree.


Synching repositories
~~~~~~~~~~~~~~~~~~~~~

505
include::cmds-synchingrepositories.txt[]
506

507
The following are helper commands used by the above; end users
508 509 510 511 512 513 514 515 516 517 518 519 520
typically do not use them directly.

include::cmds-synchelpers.txt[]


Internal helper commands
~~~~~~~~~~~~~~~~~~~~~~~~

These are internal helper commands used by other commands; end
users typically do not use them directly.

include::cmds-purehelpers.txt[]

521

J
Junio C Hamano 已提交
522 523 524
Configuration Mechanism
-----------------------

J
Junio C Hamano 已提交
525
Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
J
Junio C Hamano 已提交
526
is used to hold per-repository configuration options.  It is a
P
Pavel Roskin 已提交
527
simple text file modeled after `.ini` format familiar to some
J
Junio C Hamano 已提交
528 529 530 531
people.  Here is an example:

------------
#
J
Junio C Hamano 已提交
532
# A '#' or ';' character indicates a comment.
J
Junio C Hamano 已提交
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
#

; core variables
[core]
	; Don't trust file modes
	filemode = false

; user identity
[user]
	name = "Junio C Hamano"
	email = "junkio@twinsun.com"

------------

Various commands read from the configuration file and adjust
548 549
their operation accordingly.  See linkgit:git-config[1] for a
list.
J
Junio C Hamano 已提交
550 551


552
Identifier Terminology
553 554
----------------------
<object>::
J
Junio C Hamano 已提交
555
	Indicates the object name for any type of object.
556 557

<blob>::
J
Junio C Hamano 已提交
558
	Indicates a blob object name.
559 560

<tree>::
J
Junio C Hamano 已提交
561
	Indicates a tree object name.
562 563

<commit>::
J
Junio C Hamano 已提交
564
	Indicates a commit object name.
565 566

<tree-ish>::
J
Junio C Hamano 已提交
567
	Indicates a tree, commit or tag object name.  A
568 569 570
	command that takes a <tree-ish> argument ultimately wants to
	operate on a <tree> object but automatically dereferences
	<commit> and <tag> objects that point at a <tree>.
571

572 573 574 575 576 577
<commit-ish>::
	Indicates a commit or tag object name.  A
	command that takes a <commit-ish> argument ultimately wants to
	operate on a <commit> object but automatically dereferences
	<tag> objects that point at a <commit>.

578 579
<type>::
	Indicates that an object type is required.
J
Junio C Hamano 已提交
580
	Currently one of: `blob`, `tree`, `commit`, or `tag`.
581 582

<file>::
J
Junio C Hamano 已提交
583 584
	Indicates a filename - almost always relative to the
	root of the tree structure `GIT_INDEX_FILE` describes.
585

586 587
Symbolic Identifiers
--------------------
588
Any git command accepting any <object> can also use the following
589
symbolic notation:
590 591

HEAD::
592
	indicates the head of the current branch.
J
Junio C Hamano 已提交
593

594
<tag>::
J
Junio C Hamano 已提交
595
	a valid tag 'name'
596
	(i.e. a `refs/tags/<tag>` reference).
J
Junio C Hamano 已提交
597

598
<head>::
J
Junio C Hamano 已提交
599
	a valid head 'name'
600
	(i.e. a `refs/heads/<head>` reference).
J
Junio C Hamano 已提交
601

602
For a more complete list of ways to spell object names, see
603
"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
604

605 606 607 608

File/Directory Structure
------------------------

609
Please see the linkgit:gitrepository-layout[5] document.
610

611
Read linkgit:githooks[5] for more details about each hook.
612

613
Higher level SCMs may provide and manage additional information in the
J
Junio C Hamano 已提交
614
`$GIT_DIR`.
615

J
Junio C Hamano 已提交
616

617 618
Terminology
-----------
619
Please see linkgit:gitglossary[7].
620 621 622 623 624 625


Environment Variables
---------------------
Various git commands use the following environment variables:

626 627 628 629
The git Repository
~~~~~~~~~~~~~~~~~~
These environment variables apply to 'all' core git commands. Nb: it
is worth noting that they may be used/overridden by SCMS sitting above
J
Junio C Hamano 已提交
630
git so take care if using Cogito etc.
631 632 633

'GIT_INDEX_FILE'::
	This environment allows the specification of an alternate
634 635
	index file. If not specified, the default of `$GIT_DIR/index`
	is used.
636 637 638 639 640 641 642 643 644 645

'GIT_OBJECT_DIRECTORY'::
	If the object storage directory is specified via this
	environment variable then the sha1 directories are created
	underneath - otherwise the default `$GIT_DIR/objects`
	directory is used.

'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
	Due to the immutable nature of git objects, old objects can be
	archived into shared, read-only directories. This variable
646 647 648
	specifies a ":" separated (on Windows ";" separated) list
	of git object directories which can be used to search for git
	objects. New objects will not be written to these directories.
649 650

'GIT_DIR'::
J
Junio C Hamano 已提交
651 652 653
	If the 'GIT_DIR' environment variable is set then it
	specifies a path to use instead of the default `.git`
	for the base of the repository.
654

655 656 657 658 659 660 661
'GIT_WORK_TREE'::
	Set the path to the working tree.  The value will not be
	used in combination with repositories found automatically in
	a .git directory (i.e. $GIT_DIR is not set).
	This can also be controlled by the '--work-tree' command line
	option and the core.worktree configuration variable.

J
Josh Triplett 已提交
662 663 664 665
'GIT_NAMESPACE'::
	Set the git namespace; see linkgit:gitnamespaces[7] for details.
	The '--namespace' command-line option also sets this value.

666 667 668 669 670 671 672 673
'GIT_CEILING_DIRECTORIES'::
	This should be a colon-separated list of absolute paths.
	If set, it is a list of directories that git should not chdir
	up into while looking for a repository directory.
	It will not exclude the current working directory or
	a GIT_DIR set on the command line or in the environment.
	(Useful for excluding slow-loading network directories.)

674
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
675 676 677 678
	When run in a directory that does not have ".git" repository
	directory, git tries to find such a directory in the parent
	directories to find the top of the working tree, but by default it
	does not cross filesystem boundaries.  This environment variable
679 680 681 682
	can be set to true to tell git not to stop at filesystem
	boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
	an explicit repository directory set via 'GIT_DIR' or on the
	command line.
683

684 685 686 687 688 689 690
git Commits
~~~~~~~~~~~
'GIT_AUTHOR_NAME'::
'GIT_AUTHOR_EMAIL'::
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
691
'GIT_COMMITTER_DATE'::
692
'EMAIL'::
693
	see linkgit:git-commit-tree[1]
694 695 696

git Diffs
~~~~~~~~~
697
'GIT_DIFF_OPTS'::
698 699 700 701 702
	Only valid setting is "--unified=??" or "-u??" to set the
	number of context lines shown when a unified diff is created.
	This takes precedence over any "-U" or "--unified" option
	value passed on the git diff command line.

703
'GIT_EXTERNAL_DIFF'::
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
	When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
	program named by it is called, instead of the diff invocation
	described above.  For a path that is added, removed, or modified,
        'GIT_EXTERNAL_DIFF' is called with 7 parameters:

	path old-file old-hex old-mode new-file new-hex new-mode
+
where:

	<old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
                         contents of <old|new>,
	<old|new>-hex:: are the 40-hexdigit SHA1 hashes,
	<old|new>-mode:: are the octal representation of the file modes.
+
The file parameters can point at the user's working file
(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
when a new file is added), or a temporary file (e.g. `old-file` in the
index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
+
For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
parameter, <path>.
726

727 728
other
~~~~~
J
Jakub Narebski 已提交
729 730 731
'GIT_MERGE_VERBOSITY'::
	A number controlling the amount of output shown by
	the recursive merge strategy.  Overrides merge.verbosity.
732
	See linkgit:git-merge[1]
J
Jakub Narebski 已提交
733

734
'GIT_PAGER'::
735 736
	This environment variable overrides `$PAGER`. If it is set
	to an empty string or to the value "cat", git will not launch
737 738
	a pager.  See also the `core.pager` option in
	linkgit:git-config[1].
739

740 741
'GIT_EDITOR'::
	This environment variable overrides `$EDITOR` and `$VISUAL`.
M
Miklos Vajna 已提交
742
	It is used by several git commands when, on interactive mode,
743 744 745
	an editor is to be launched. See also linkgit:git-var[1]
	and the `core.editor` option in linkgit:git-config[1].

746
'GIT_SSH'::
747 748
	If this environment variable is set then 'git fetch'
	and 'git push' will use this command instead
749
	of 'ssh' when they need to connect to a remote system.
750
	The '$GIT_SSH' command will be given exactly two arguments:
751 752 753 754 755 756 757 758 759 760 761
	the 'username@host' (or just 'host') from the URL and the
	shell command to execute on that remote system.
+
To pass options to the program that you want to list in GIT_SSH
you will need to wrap the program and options into a shell script,
then set GIT_SSH to refer to the shell script.
+
Usually it is easier to configure any desired options through your
personal `.ssh/config` file.  Please consult your ssh documentation
for further details.

762 763 764 765 766 767 768
'GIT_ASKPASS'::
	If this environment variable is set, then git commands which need to
	acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
	will call this program with a suitable prompt as command line argument
	and read the password from its STDOUT. See also the 'core.askpass'
	option in linkgit:git-config[1].

769 770
'GIT_FLUSH'::
	If this environment variable is set to "1", then commands such
771 772
	as 'git blame' (in incremental mode), 'git rev-list', 'git log',
	and 'git whatchanged' will force a flush of the output stream
773 774 775 776 777 778
	after each commit-oriented record have been flushed.   If this
	variable is set to "0", the output of these commands will be done
	using completely buffered I/O.   If this environment variable is
	not set, git will choose buffered or record-oriented flushing
	based on whether stdout appears to be redirected to a file or not.

779
'GIT_TRACE'::
780 781
	If this variable is set to "1", "2" or "true" (comparison
	is case insensitive), git will print `trace:` messages on
782 783
	stderr telling about alias expansion, built-in command
	execution and external command execution.
784 785 786 787 788 789 790 791
	If this variable is set to an integer value greater than 1
	and lower than 10 (strictly) then git will interpret this
	value as an open file descriptor and will try to write the
	trace messages into this file descriptor.
	Alternatively, if this variable is set to an absolute path
	(starting with a '/' character), git will interpret this
	as a file path and will try to write the trace messages
	into it.
792

J
Junio C Hamano 已提交
793 794
Discussion[[Discussion]]
------------------------
795 796 797

More detail on the following is available from the
link:user-manual.html#git-concepts[git concepts chapter of the
798
user-manual] and linkgit:gitcore-tutorial[7].
799 800 801 802 803 804 805 806 807 808

A git project normally consists of a working directory with a ".git"
subdirectory at the top level.  The .git directory contains, among other
things, a compressed object database representing the complete history
of the project, an "index" file which links that history to the current
contents of the working tree, and named pointers into that history such
as tags and branch heads.

The object database contains objects of three main types: blobs, which
hold file data; trees, which point to blobs and other trees to build up
R
Ralf Wildenhues 已提交
809
directory hierarchies; and commits, which each reference a single tree
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
and some number of parent commits.

The commit, equivalent to what other systems call a "changeset" or
"version", represents a step in the project's history, and each parent
represents an immediately preceding step.  Commits with more than one
parent represent merges of independent lines of development.

All objects are named by the SHA1 hash of their contents, normally
written as a string of 40 hex digits.  Such names are globally unique.
The entire history leading up to a commit can be vouched for by signing
just that commit.  A fourth object type, the tag, is provided for this
purpose.

When first created, objects are stored in individual files, but for
efficiency may later be compressed together into "pack files".

Named pointers called refs mark interesting points in history.  A ref
may contain the SHA1 name of an object or the name of another ref.  Refs
with names beginning `ref/head/` contain the SHA1 name of the most
R
Ralf Wildenhues 已提交
829
recent commit (or "head") of a branch under development.  SHA1 names of
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
tags of interest are stored under `ref/tags/`.  A special ref named
`HEAD` contains the name of the currently checked-out branch.

The index file is initialized with a list of all paths and, for each
path, a blob object and a set of attributes.  The blob object represents
the contents of the file as of the head of the current branch.  The
attributes (last modified time, size, etc.) are taken from the
corresponding file in the working tree.  Subsequent changes to the
working tree can be found by comparing these attributes.  The index may
be updated with new content, and new commits may be created from the
content stored in the index.

The index is also capable of storing multiple entries (called "stages")
for a given pathname.  These stages are used to hold the various
unmerged version of a file when a merge is in progress.
845

846 847
Authors
-------
848 849
Git was started by Linus Torvalds, and is currently maintained by Junio
C Hamano. Numerous contributions have come from the git mailing list
850 851 852 853
<git@vger.kernel.org>. For a more complete list of contributors, see
http://git-scm.com/about. If you have a clone of git.git itself, the
output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
the authors for specific parts of the project.
854

J
Junio C Hamano 已提交
855 856 857 858 859 860 861
Reporting Bugs
--------------

Report bugs to the Git mailing list <git@vger.kernel.org> where the
development and maintenance is primarily done.  You do not have to be
subscribed to the list to send a message there.

862 863 864
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
865
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
866
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
867 868
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7]
869

870 871
GIT
---
872
Part of the linkgit:git[1] suite