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.2/git.html[documentation for release 1.7.12.2]
J
Junio C Hamano 已提交
47 48

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

endif::stalenotes[]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

416

417 418
GIT COMMANDS
------------
419

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

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

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

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
431

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

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

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

440
Interrogators:
441

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

444 445 446 447 448 449 450 451 452 453

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

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

include::cmds-foreignscminterface.txt[]


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

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

476

477 478 479
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

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


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

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

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


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

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

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

511

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

595 596 597 598

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

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

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

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

J
Junio C Hamano 已提交
606

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
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].


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

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

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

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