git.txt 28.0 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 27
link:everyday.html[Everyday Git] for a useful minimum set of
commands.  The link:user-manual.html[Git User's Manual] has a more
in-depth introduction.
28

29 30 31 32
After you mastered the basic concepts, you can come back to this
page to learn what commands git offers.  You can learn more about
individual git commands with "git help command".  linkgit:gitcli[7]
manual page gives you an overview of the command line command syntax.
P
Petr Baudis 已提交
33

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

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

41 42 43 44
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:
45

J
Junio C Hamano 已提交
46
* link:v1.7.12.1/git.html[documentation for release 1.7.12.1]
J
Junio C Hamano 已提交
47 48

* release notes for
J
Junio C Hamano 已提交
49
  link:RelNotes/1.7.12.1.txt[1.7.12.1],
J
Junio C Hamano 已提交
50 51
  link:RelNotes/1.7.12.txt[1.7.12].

J
Junio C Hamano 已提交
52
* link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
J
Junio C Hamano 已提交
53 54

* release notes for
J
Junio C Hamano 已提交
55
  link:RelNotes/1.7.11.7.txt[1.7.11.7],
J
Junio C Hamano 已提交
56
  link:RelNotes/1.7.11.6.txt[1.7.11.6],
J
Junio C Hamano 已提交
57
  link:RelNotes/1.7.11.5.txt[1.7.11.5],
J
Junio C Hamano 已提交
58
  link:RelNotes/1.7.11.4.txt[1.7.11.4],
J
Junio C Hamano 已提交
59
  link:RelNotes/1.7.11.3.txt[1.7.11.3],
J
Junio C Hamano 已提交
60
  link:RelNotes/1.7.11.2.txt[1.7.11.2],
J
Junio C Hamano 已提交
61
  link:RelNotes/1.7.11.1.txt[1.7.11.1],
J
Junio C Hamano 已提交
62 63
  link:RelNotes/1.7.11.txt[1.7.11].

J
Junio C Hamano 已提交
64
* link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
J
Junio C Hamano 已提交
65 66

* release notes for
J
Junio C Hamano 已提交
67
  link:RelNotes/1.7.10.5.txt[1.7.10.5],
J
Junio C Hamano 已提交
68
  link:RelNotes/1.7.10.4.txt[1.7.10.4],
J
Junio C Hamano 已提交
69
  link:RelNotes/1.7.10.3.txt[1.7.10.3],
J
Junio C Hamano 已提交
70
  link:RelNotes/1.7.10.2.txt[1.7.10.2],
J
Junio C Hamano 已提交
71
  link:RelNotes/1.7.10.1.txt[1.7.10.1],
J
Junio C Hamano 已提交
72 73
  link:RelNotes/1.7.10.txt[1.7.10].

J
Junio C Hamano 已提交
74
* link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
J
Junio C Hamano 已提交
75 76

* release notes for
J
Junio C Hamano 已提交
77
  link:RelNotes/1.7.9.7.txt[1.7.9.7],
J
Junio C Hamano 已提交
78
  link:RelNotes/1.7.9.6.txt[1.7.9.6],
J
Junio C Hamano 已提交
79
  link:RelNotes/1.7.9.5.txt[1.7.9.5],
J
Junio C Hamano 已提交
80
  link:RelNotes/1.7.9.4.txt[1.7.9.4],
J
Junio C Hamano 已提交
81
  link:RelNotes/1.7.9.3.txt[1.7.9.3],
J
Junio C Hamano 已提交
82
  link:RelNotes/1.7.9.2.txt[1.7.9.2],
J
Junio C Hamano 已提交
83
  link:RelNotes/1.7.9.1.txt[1.7.9.1],
J
Junio C Hamano 已提交
84 85
  link:RelNotes/1.7.9.txt[1.7.9].

J
Junio C Hamano 已提交
86
* link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
J
Junio C Hamano 已提交
87 88

* release notes for
J
Junio C Hamano 已提交
89
  link:RelNotes/1.7.8.6.txt[1.7.8.6],
J
Junio C Hamano 已提交
90
  link:RelNotes/1.7.8.5.txt[1.7.8.5],
J
Junio C Hamano 已提交
91
  link:RelNotes/1.7.8.4.txt[1.7.8.4],
J
Junio C Hamano 已提交
92 93 94
  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 已提交
95 96
  link:RelNotes/1.7.8.txt[1.7.8].

J
Junio C Hamano 已提交
97
* link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
J
Junio C Hamano 已提交
98 99

* release notes for
J
Junio C Hamano 已提交
100
  link:RelNotes/1.7.7.7.txt[1.7.7.7],
J
Junio C Hamano 已提交
101
  link:RelNotes/1.7.7.6.txt[1.7.7.6],
J
Junio C Hamano 已提交
102 103 104 105
  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 已提交
106
  link:RelNotes/1.7.7.1.txt[1.7.7.1],
J
Junio C Hamano 已提交
107 108
  link:RelNotes/1.7.7.txt[1.7.7].

J
Junio C Hamano 已提交
109
* link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
J
Junio C Hamano 已提交
110 111

* release notes for
J
Junio C Hamano 已提交
112
  link:RelNotes/1.7.6.6.txt[1.7.6.6],
J
Junio C Hamano 已提交
113
  link:RelNotes/1.7.6.5.txt[1.7.6.5],
J
Junio C Hamano 已提交
114
  link:RelNotes/1.7.6.4.txt[1.7.6.4],
J
Junio C Hamano 已提交
115
  link:RelNotes/1.7.6.3.txt[1.7.6.3],
J
Junio C Hamano 已提交
116 117
  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 已提交
118 119
  link:RelNotes/1.7.6.txt[1.7.6].

J
Junio C Hamano 已提交
120
* link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
J
Junio C Hamano 已提交
121 122

* release notes for
J
Junio C Hamano 已提交
123
  link:RelNotes/1.7.5.4.txt[1.7.5.4],
J
Junio C Hamano 已提交
124
  link:RelNotes/1.7.5.3.txt[1.7.5.3],
J
Junio C Hamano 已提交
125
  link:RelNotes/1.7.5.2.txt[1.7.5.2],
J
Junio C Hamano 已提交
126
  link:RelNotes/1.7.5.1.txt[1.7.5.1],
J
Junio C Hamano 已提交
127 128
  link:RelNotes/1.7.5.txt[1.7.5].

J
Junio C Hamano 已提交
129
* link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
J
Junio C Hamano 已提交
130 131

* release notes for
J
Junio C Hamano 已提交
132
  link:RelNotes/1.7.4.5.txt[1.7.4.5],
J
Junio C Hamano 已提交
133
  link:RelNotes/1.7.4.4.txt[1.7.4.4],
J
Junio C Hamano 已提交
134 135
  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 已提交
136
  link:RelNotes/1.7.4.1.txt[1.7.4.1],
J
Junio C Hamano 已提交
137 138
  link:RelNotes/1.7.4.txt[1.7.4].

J
Junio C Hamano 已提交
139
* link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
J
Junio C Hamano 已提交
140 141

* release notes for
J
Junio C Hamano 已提交
142
  link:RelNotes/1.7.3.5.txt[1.7.3.5],
J
Junio C Hamano 已提交
143
  link:RelNotes/1.7.3.4.txt[1.7.3.4],
144
  link:RelNotes/1.7.3.3.txt[1.7.3.3],
J
Junio C Hamano 已提交
145
  link:RelNotes/1.7.3.2.txt[1.7.3.2],
J
Junio C Hamano 已提交
146
  link:RelNotes/1.7.3.1.txt[1.7.3.1],
J
Junio C Hamano 已提交
147 148
  link:RelNotes/1.7.3.txt[1.7.3].

149
* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
J
Junio C Hamano 已提交
150 151

* release notes for
152
  link:RelNotes/1.7.2.5.txt[1.7.2.5],
153
  link:RelNotes/1.7.2.4.txt[1.7.2.4],
154 155 156 157
  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 已提交
158

159
* link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
J
Junio C Hamano 已提交
160 161

* release notes for
162
  link:RelNotes/1.7.1.4.txt[1.7.1.4],
163
  link:RelNotes/1.7.1.3.txt[1.7.1.3],
164 165 166
  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 已提交
167

168
* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
J
Junio C Hamano 已提交
169 170

* release notes for
171
  link:RelNotes/1.7.0.9.txt[1.7.0.9],
172
  link:RelNotes/1.7.0.8.txt[1.7.0.8],
173 174 175 176 177 178 179 180
  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 已提交
181

182
* link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
J
Junio C Hamano 已提交
183 184

* release notes for
185
  link:RelNotes/1.6.6.3.txt[1.6.6.3],
186 187 188
  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 已提交
189

190
* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
J
Junio C Hamano 已提交
191 192

* release notes for
193
  link:RelNotes/1.6.5.9.txt[1.6.5.9],
194 195 196 197 198 199 200 201 202
  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 已提交
203

204
* link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
J
Junio C Hamano 已提交
205 206

* release notes for
207
  link:RelNotes/1.6.4.5.txt[1.6.4.5],
208 209 210 211 212
  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 已提交
213

J
Junio C Hamano 已提交
214
* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
215 216

* release notes for
217 218 219 220 221
  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 已提交
222 223

* release notes for
224 225 226 227 228 229
  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 已提交
230

J
Junio C Hamano 已提交
231
* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
J
Junio C Hamano 已提交
232 233

* release notes for
234 235 236 237
  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 已提交
238

239
* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
J
Junio C Hamano 已提交
240 241

* release notes for
242 243 244 245 246 247 248
  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 已提交
249

250
* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
J
Junio C Hamano 已提交
251 252

* release notes for
253 254 255 256 257 258 259
  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 已提交
260

261
* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
J
Junio C Hamano 已提交
262 263

* release notes for
264 265 266 267 268 269 270
  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 已提交
271

272
* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
273 274

* release notes for
275 276 277 278 279 280 281 282
  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].
283

J
Junio C Hamano 已提交
284
* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
285 286

* release notes for
287 288 289 290 291 292 293 294 295
  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].
296

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

J
Junio C Hamano 已提交
299
* release notes for
300 301 302 303 304 305
  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 已提交
306 307 308 309

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

* release notes for
310 311 312 313 314 315 316
  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].
317 318 319

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

J
Junio C Hamano 已提交
320
* release notes for
321 322 323 324 325 326 327
  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].
328 329 330 331 332

* 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].
333 334 335 336 337

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

endif::stalenotes[]

338 339 340
OPTIONS
-------
--version::
F
Fredrik Kuivinen 已提交
341
	Prints the git suite version that the 'git' program came from.
342 343

--help::
F
Fredrik Kuivinen 已提交
344
	Prints the synopsis and a list of the most commonly used
345 346 347
	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.
348 349
+
Other options are available to control how the manual page is
350
displayed. See linkgit:git-help[1] for more information,
351 352
because `git --help ...` is converted internally into `git
help ...`.
353

354 355 356 357 358 359
-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).

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

366
--html-path::
367 368
	Print the path, without trailing slash, where git's HTML
	documentation is installed and exit.
369

370
--man-path::
371 372
	Print the manpath (see `man(1)`) for the man pages for
	this version of git and exit.
373 374

--info-path::
375 376
	Print the path where the Info files documenting this
	version of git are installed and exit.
377

378 379
-p::
--paginate::
380 381 382 383
	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).
384

385 386 387
--no-pager::
	Do not pipe git output into a pager.

388 389
--git-dir=<path>::
	Set the path to the repository. This can also be controlled by
390 391
	setting the GIT_DIR environment variable. It can be an absolute
	path or relative path to current working directory.
392

393
--work-tree=<path>::
394 395
	Set the path to the working tree. It can be an absolute path
	or a path relative to the current working directory.
396 397
	This can also be controlled by setting the GIT_WORK_TREE
	environment variable and the core.worktree configuration
398 399
	variable (see core.worktree in linkgit:git-config[1] for a
	more detailed discussion).
400

J
Josh Triplett 已提交
401 402 403 404 405
--namespace=<path>::
	Set the git namespace.  See linkgit:gitnamespaces[7] for more
	details.  Equivalent to setting the `GIT_NAMESPACE` environment
	variable.

406
--bare::
407 408 409 410
	Treat the repository as a bare repository.  If GIT_DIR
	environment is not set, it is set to the current working
	directory.

411 412 413 414
--no-replace-objects::
	Do not use replacement refs to replace git objects. See
	linkgit:git-replace[1] for more information.

415

416 417
GIT COMMANDS
------------
418

419 420
We divide git into high level ("porcelain") commands and low level
("plumbing") commands.
421

422 423 424 425 426 427 428 429
High-level commands (porcelain)
-------------------------------

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

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
430

431
include::cmds-mainporcelain.txt[]
432

433
Ancillary Commands
434
~~~~~~~~~~~~~~~~~~
435 436
Manipulators:

437
include::cmds-ancillarymanipulators.txt[]
438

439
Interrogators:
440

441
include::cmds-ancillaryinterrogators.txt[]
442

443 444 445 446 447 448 449 450 451 452

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

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

include::cmds-foreignscminterface.txt[]


453 454 455 456 457 458
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
459 460
might start by reading about linkgit:git-update-index[1] and
linkgit:git-read-tree[1].
461

462 463 464 465 466 467 468 469 470
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
471 472 473 474
the repository, index, and working tree), commands that interrogate and
compare objects, and commands that move objects and references between
repositories.

475

476 477 478
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

479
include::cmds-plumbingmanipulators.txt[]
480 481 482 483 484


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

485
include::cmds-plumbinginterrogators.txt[]
486 487 488 489 490 491 492 493

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


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

494
include::cmds-synchingrepositories.txt[]
495

496
The following are helper commands used by the above; end users
497 498 499 500 501 502 503 504 505 506 507 508 509
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[]

510

J
Junio C Hamano 已提交
511 512 513
Configuration Mechanism
-----------------------

J
Junio C Hamano 已提交
514
Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
J
Junio C Hamano 已提交
515
is used to hold per-repository configuration options.  It is a
P
Pavel Roskin 已提交
516
simple text file modeled after `.ini` format familiar to some
J
Junio C Hamano 已提交
517 518 519 520
people.  Here is an example:

------------
#
J
Junio C Hamano 已提交
521
# A '#' or ';' character indicates a comment.
J
Junio C Hamano 已提交
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
#

; 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
537 538
their operation accordingly.  See linkgit:git-config[1] for a
list.
J
Junio C Hamano 已提交
539 540


541
Identifier Terminology
542 543
----------------------
<object>::
J
Junio C Hamano 已提交
544
	Indicates the object name for any type of object.
545 546

<blob>::
J
Junio C Hamano 已提交
547
	Indicates a blob object name.
548 549

<tree>::
J
Junio C Hamano 已提交
550
	Indicates a tree object name.
551 552

<commit>::
J
Junio C Hamano 已提交
553
	Indicates a commit object name.
554 555

<tree-ish>::
J
Junio C Hamano 已提交
556
	Indicates a tree, commit or tag object name.  A
557 558 559
	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>.
560

561 562 563 564 565 566
<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>.

567 568
<type>::
	Indicates that an object type is required.
J
Junio C Hamano 已提交
569
	Currently one of: `blob`, `tree`, `commit`, or `tag`.
570 571

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

575 576
Symbolic Identifiers
--------------------
577
Any git command accepting any <object> can also use the following
578
symbolic notation:
579 580

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

583
<tag>::
J
Junio C Hamano 已提交
584
	a valid tag 'name'
585
	(i.e. a `refs/tags/<tag>` reference).
J
Junio C Hamano 已提交
586

587
<head>::
J
Junio C Hamano 已提交
588
	a valid head 'name'
589
	(i.e. a `refs/heads/<head>` reference).
J
Junio C Hamano 已提交
590

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

594 595 596 597

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

598
Please see the linkgit:gitrepository-layout[5] document.
599

600
Read linkgit:githooks[5] for more details about each hook.
601

602
Higher level SCMs may provide and manage additional information in the
J
Junio C Hamano 已提交
603
`$GIT_DIR`.
604

J
Junio C Hamano 已提交
605

606 607
Terminology
-----------
608
Please see linkgit:gitglossary[7].
609 610 611 612 613 614


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

615 616 617 618
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 已提交
619
git so take care if using Cogito etc.
620 621 622

'GIT_INDEX_FILE'::
	This environment allows the specification of an alternate
623 624
	index file. If not specified, the default of `$GIT_DIR/index`
	is used.
625 626 627 628 629 630 631 632 633 634

'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
635 636 637
	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.
638 639

'GIT_DIR'::
J
Junio C Hamano 已提交
640 641 642
	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.
643

644 645 646 647 648 649 650
'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 已提交
651 652 653 654
'GIT_NAMESPACE'::
	Set the git namespace; see linkgit:gitnamespaces[7] for details.
	The '--namespace' command-line option also sets this value.

655 656 657 658 659 660 661 662
'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.)

663
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
664 665 666 667
	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
668 669 670 671
	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.
672

673 674 675 676 677 678 679
git Commits
~~~~~~~~~~~
'GIT_AUTHOR_NAME'::
'GIT_AUTHOR_EMAIL'::
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
680
'GIT_COMMITTER_DATE'::
681
'EMAIL'::
682
	see linkgit:git-commit-tree[1]
683 684 685

git Diffs
~~~~~~~~~
686
'GIT_DIFF_OPTS'::
687 688 689 690 691
	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.

692
'GIT_EXTERNAL_DIFF'::
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
	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>.
715

716 717
other
~~~~~
J
Jakub Narebski 已提交
718 719 720
'GIT_MERGE_VERBOSITY'::
	A number controlling the amount of output shown by
	the recursive merge strategy.  Overrides merge.verbosity.
721
	See linkgit:git-merge[1]
J
Jakub Narebski 已提交
722

723
'GIT_PAGER'::
724 725
	This environment variable overrides `$PAGER`. If it is set
	to an empty string or to the value "cat", git will not launch
726 727
	a pager.  See also the `core.pager` option in
	linkgit:git-config[1].
728

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

735
'GIT_SSH'::
736 737
	If this environment variable is set then 'git fetch'
	and 'git push' will use this command instead
738
	of 'ssh' when they need to connect to a remote system.
739
	The '$GIT_SSH' command will be given exactly two arguments:
740 741 742 743 744 745 746 747 748 749 750
	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.

751 752 753 754 755 756 757
'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].

758 759
'GIT_FLUSH'::
	If this environment variable is set to "1", then commands such
760 761
	as 'git blame' (in incremental mode), 'git rev-list', 'git log',
	and 'git whatchanged' will force a flush of the output stream
762 763 764 765 766 767
	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.

768
'GIT_TRACE'::
769 770
	If this variable is set to "1", "2" or "true" (comparison
	is case insensitive), git will print `trace:` messages on
771 772
	stderr telling about alias expansion, built-in command
	execution and external command execution.
773 774 775 776 777 778 779 780
	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.
781

J
Junio C Hamano 已提交
782 783
Discussion[[Discussion]]
------------------------
784 785 786

More detail on the following is available from the
link:user-manual.html#git-concepts[git concepts chapter of the
787
user-manual] and linkgit:gitcore-tutorial[7].
788 789 790 791 792 793 794 795 796 797

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 已提交
798
directory hierarchies; and commits, which each reference a single tree
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
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 已提交
818
recent commit (or "head") of a branch under development.  SHA1 names of
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
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.
834

835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
FURTHER DOCUMENTATION
---------------------

See the references in the "description" section to get started
using git.  The following is probably more detail than necessary
for a first-time user.

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

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

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

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

Users migrating from CVS may also want to
read linkgit:gitcvs-migration[7].


858 859
Authors
-------
860 861
Git was started by Linus Torvalds, and is currently maintained by Junio
C Hamano. Numerous contributions have come from the git mailing list
862 863 864 865
<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.
866

J
Junio C Hamano 已提交
867 868 869 870 871 872 873
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.

874 875 876
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
877
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
878
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
879 880
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7]
881

882 883
GIT
---
884
Part of the linkgit:git[1] suite