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

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

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

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

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

* release notes for
J
Junio C Hamano 已提交
49
  link:RelNotes/1.8.2.3.txt[1.8.2.3].
J
Junio C Hamano 已提交
50
  link:RelNotes/1.8.2.2.txt[1.8.2.2].
J
Junio C Hamano 已提交
51
  link:RelNotes/1.8.2.1.txt[1.8.2.1].
J
Junio C Hamano 已提交
52 53
  link:RelNotes/1.8.2.txt[1.8.2].

J
Junio C Hamano 已提交
54
* link:v1.8.1.6/git.html[documentation for release 1.8.1.6]
J
Junio C Hamano 已提交
55 56

* release notes for
J
Junio C Hamano 已提交
57
  link:RelNotes/1.8.1.6.txt[1.8.1.6],
J
Junio C Hamano 已提交
58
  link:RelNotes/1.8.1.5.txt[1.8.1.5],
J
Junio C Hamano 已提交
59
  link:RelNotes/1.8.1.4.txt[1.8.1.4],
J
Junio C Hamano 已提交
60 61
  link:RelNotes/1.8.1.3.txt[1.8.1.3],
  link:RelNotes/1.8.1.2.txt[1.8.1.2],
J
Junio C Hamano 已提交
62
  link:RelNotes/1.8.1.1.txt[1.8.1.1],
J
Junio C Hamano 已提交
63 64
  link:RelNotes/1.8.1.txt[1.8.1].

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

* release notes for
J
Junio C Hamano 已提交
68
  link:RelNotes/1.8.0.3.txt[1.8.0.3],
J
Junio C Hamano 已提交
69
  link:RelNotes/1.8.0.2.txt[1.8.0.2],
J
Junio C Hamano 已提交
70 71
  link:RelNotes/1.8.0.1.txt[1.8.0.1],
  link:RelNotes/1.8.0.txt[1.8.0].
J
Junio C Hamano 已提交
72

J
Junio C Hamano 已提交
73
* link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
J
Junio C Hamano 已提交
74 75

* release notes for
J
Junio C Hamano 已提交
76
  link:RelNotes/1.7.12.4.txt[1.7.12.4],
J
Junio C Hamano 已提交
77
  link:RelNotes/1.7.12.3.txt[1.7.12.3],
J
Junio C Hamano 已提交
78
  link:RelNotes/1.7.12.2.txt[1.7.12.2],
J
Junio C Hamano 已提交
79
  link:RelNotes/1.7.12.1.txt[1.7.12.1],
J
Junio C Hamano 已提交
80 81
  link:RelNotes/1.7.12.txt[1.7.12].

J
Junio C Hamano 已提交
82
* link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
J
Junio C Hamano 已提交
83 84

* release notes for
J
Junio C Hamano 已提交
85
  link:RelNotes/1.7.11.7.txt[1.7.11.7],
J
Junio C Hamano 已提交
86
  link:RelNotes/1.7.11.6.txt[1.7.11.6],
J
Junio C Hamano 已提交
87
  link:RelNotes/1.7.11.5.txt[1.7.11.5],
J
Junio C Hamano 已提交
88
  link:RelNotes/1.7.11.4.txt[1.7.11.4],
J
Junio C Hamano 已提交
89
  link:RelNotes/1.7.11.3.txt[1.7.11.3],
J
Junio C Hamano 已提交
90
  link:RelNotes/1.7.11.2.txt[1.7.11.2],
J
Junio C Hamano 已提交
91
  link:RelNotes/1.7.11.1.txt[1.7.11.1],
J
Junio C Hamano 已提交
92 93
  link:RelNotes/1.7.11.txt[1.7.11].

J
Junio C Hamano 已提交
94
* link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
J
Junio C Hamano 已提交
95 96

* release notes for
J
Junio C Hamano 已提交
97
  link:RelNotes/1.7.10.5.txt[1.7.10.5],
J
Junio C Hamano 已提交
98
  link:RelNotes/1.7.10.4.txt[1.7.10.4],
J
Junio C Hamano 已提交
99
  link:RelNotes/1.7.10.3.txt[1.7.10.3],
J
Junio C Hamano 已提交
100
  link:RelNotes/1.7.10.2.txt[1.7.10.2],
J
Junio C Hamano 已提交
101
  link:RelNotes/1.7.10.1.txt[1.7.10.1],
J
Junio C Hamano 已提交
102 103
  link:RelNotes/1.7.10.txt[1.7.10].

J
Junio C Hamano 已提交
104
* link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
J
Junio C Hamano 已提交
105 106

* release notes for
J
Junio C Hamano 已提交
107
  link:RelNotes/1.7.9.7.txt[1.7.9.7],
J
Junio C Hamano 已提交
108
  link:RelNotes/1.7.9.6.txt[1.7.9.6],
J
Junio C Hamano 已提交
109
  link:RelNotes/1.7.9.5.txt[1.7.9.5],
J
Junio C Hamano 已提交
110
  link:RelNotes/1.7.9.4.txt[1.7.9.4],
J
Junio C Hamano 已提交
111
  link:RelNotes/1.7.9.3.txt[1.7.9.3],
J
Junio C Hamano 已提交
112
  link:RelNotes/1.7.9.2.txt[1.7.9.2],
J
Junio C Hamano 已提交
113
  link:RelNotes/1.7.9.1.txt[1.7.9.1],
J
Junio C Hamano 已提交
114 115
  link:RelNotes/1.7.9.txt[1.7.9].

J
Junio C Hamano 已提交
116
* link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
J
Junio C Hamano 已提交
117 118

* release notes for
J
Junio C Hamano 已提交
119
  link:RelNotes/1.7.8.6.txt[1.7.8.6],
J
Junio C Hamano 已提交
120
  link:RelNotes/1.7.8.5.txt[1.7.8.5],
J
Junio C Hamano 已提交
121
  link:RelNotes/1.7.8.4.txt[1.7.8.4],
J
Junio C Hamano 已提交
122 123 124
  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 已提交
125 126
  link:RelNotes/1.7.8.txt[1.7.8].

J
Junio C Hamano 已提交
127
* link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
J
Junio C Hamano 已提交
128 129

* release notes for
J
Junio C Hamano 已提交
130
  link:RelNotes/1.7.7.7.txt[1.7.7.7],
J
Junio C Hamano 已提交
131
  link:RelNotes/1.7.7.6.txt[1.7.7.6],
J
Junio C Hamano 已提交
132 133 134 135
  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 已提交
136
  link:RelNotes/1.7.7.1.txt[1.7.7.1],
J
Junio C Hamano 已提交
137 138
  link:RelNotes/1.7.7.txt[1.7.7].

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

* release notes for
J
Junio C Hamano 已提交
142
  link:RelNotes/1.7.6.6.txt[1.7.6.6],
J
Junio C Hamano 已提交
143
  link:RelNotes/1.7.6.5.txt[1.7.6.5],
J
Junio C Hamano 已提交
144
  link:RelNotes/1.7.6.4.txt[1.7.6.4],
J
Junio C Hamano 已提交
145
  link:RelNotes/1.7.6.3.txt[1.7.6.3],
J
Junio C Hamano 已提交
146 147
  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 已提交
148 149
  link:RelNotes/1.7.6.txt[1.7.6].

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

* release notes for
J
Junio C Hamano 已提交
153
  link:RelNotes/1.7.5.4.txt[1.7.5.4],
J
Junio C Hamano 已提交
154
  link:RelNotes/1.7.5.3.txt[1.7.5.3],
J
Junio C Hamano 已提交
155
  link:RelNotes/1.7.5.2.txt[1.7.5.2],
J
Junio C Hamano 已提交
156
  link:RelNotes/1.7.5.1.txt[1.7.5.1],
J
Junio C Hamano 已提交
157 158
  link:RelNotes/1.7.5.txt[1.7.5].

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

* release notes for
J
Junio C Hamano 已提交
162
  link:RelNotes/1.7.4.5.txt[1.7.4.5],
J
Junio C Hamano 已提交
163
  link:RelNotes/1.7.4.4.txt[1.7.4.4],
J
Junio C Hamano 已提交
164 165
  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 已提交
166
  link:RelNotes/1.7.4.1.txt[1.7.4.1],
J
Junio C Hamano 已提交
167 168
  link:RelNotes/1.7.4.txt[1.7.4].

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

* release notes for
J
Junio C Hamano 已提交
172
  link:RelNotes/1.7.3.5.txt[1.7.3.5],
J
Junio C Hamano 已提交
173
  link:RelNotes/1.7.3.4.txt[1.7.3.4],
174
  link:RelNotes/1.7.3.3.txt[1.7.3.3],
J
Junio C Hamano 已提交
175
  link:RelNotes/1.7.3.2.txt[1.7.3.2],
J
Junio C Hamano 已提交
176
  link:RelNotes/1.7.3.1.txt[1.7.3.1],
J
Junio C Hamano 已提交
177 178
  link:RelNotes/1.7.3.txt[1.7.3].

179
* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
J
Junio C Hamano 已提交
180 181

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

189
* link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
J
Junio C Hamano 已提交
190 191

* release notes for
192
  link:RelNotes/1.7.1.4.txt[1.7.1.4],
193
  link:RelNotes/1.7.1.3.txt[1.7.1.3],
194 195 196
  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 已提交
197

198
* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
J
Junio C Hamano 已提交
199 200

* release notes for
201
  link:RelNotes/1.7.0.9.txt[1.7.0.9],
202
  link:RelNotes/1.7.0.8.txt[1.7.0.8],
203 204 205 206 207 208 209 210
  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 已提交
211

212
* link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
J
Junio C Hamano 已提交
213 214

* release notes for
215
  link:RelNotes/1.6.6.3.txt[1.6.6.3],
216 217 218
  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 已提交
219

220
* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
J
Junio C Hamano 已提交
221 222

* release notes for
223
  link:RelNotes/1.6.5.9.txt[1.6.5.9],
224 225 226 227 228 229 230 231 232
  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 已提交
233

234
* link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
J
Junio C Hamano 已提交
235 236

* release notes for
237
  link:RelNotes/1.6.4.5.txt[1.6.4.5],
238 239 240 241 242
  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 已提交
243

J
Junio C Hamano 已提交
244
* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
245 246

* release notes for
247 248 249 250 251
  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 已提交
252 253

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

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

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

269
* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
J
Junio C Hamano 已提交
270 271

* release notes for
272 273 274 275 276 277 278
  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 已提交
279

280
* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
J
Junio C Hamano 已提交
281 282

* release notes for
283 284 285 286 287 288 289
  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 已提交
290

291
* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
J
Junio C Hamano 已提交
292 293

* release notes for
294 295 296 297 298 299 300
  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 已提交
301

302
* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
303 304

* release notes for
305 306 307 308 309 310 311 312
  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].
313

J
Junio C Hamano 已提交
314
* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
315 316

* release notes for
317 318 319 320 321 322 323 324 325
  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].
326

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

J
Junio C Hamano 已提交
329
* release notes for
330 331 332 333 334 335
  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 已提交
336 337 338 339

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

* release notes for
340 341 342 343 344 345 346
  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].
347 348 349

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

J
Junio C Hamano 已提交
350
* release notes for
351 352 353 354 355 356 357
  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].
358 359 360 361 362

* 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].
363 364 365 366 367

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

endif::stalenotes[]

368 369 370
OPTIONS
-------
--version::
371
	Prints the Git suite version that the 'git' program came from.
372 373

--help::
F
Fredrik Kuivinen 已提交
374
	Prints the synopsis and a list of the most commonly used
375
	commands. If the option '--all' or '-a' is given then all
376
	available commands are printed. If a Git command is named this
377
	option will bring up the manual page for that command.
378 379
+
Other options are available to control how the manual page is
380
displayed. See linkgit:git-help[1] for more information,
381 382
because `git --help ...` is converted internally into `git
help ...`.
383

384 385 386 387 388 389
-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).

390
--exec-path[=<path>]::
391
	Path to wherever your core Git programs are installed.
392
	This can also be controlled by setting the GIT_EXEC_PATH
J
Jonathan Nieder 已提交
393
	environment variable. If no path is given, 'git' will print
394 395
	the current setting and then exit.

396
--html-path::
397
	Print the path, without trailing slash, where Git's HTML
398
	documentation is installed and exit.
399

400
--man-path::
401
	Print the manpath (see `man(1)`) for the man pages for
402
	this version of Git and exit.
403 404

--info-path::
405
	Print the path where the Info files documenting this
406
	version of Git are installed and exit.
407

408 409
-p::
--paginate::
410 411 412 413
	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).
414

415
--no-pager::
416
	Do not pipe Git output into a pager.
417

418 419
--git-dir=<path>::
	Set the path to the repository. This can also be controlled by
420 421
	setting the GIT_DIR environment variable. It can be an absolute
	path or relative path to current working directory.
422

423
--work-tree=<path>::
424 425
	Set the path to the working tree. It can be an absolute path
	or a path relative to the current working directory.
426 427
	This can also be controlled by setting the GIT_WORK_TREE
	environment variable and the core.worktree configuration
428 429
	variable (see core.worktree in linkgit:git-config[1] for a
	more detailed discussion).
430

J
Josh Triplett 已提交
431
--namespace=<path>::
432
	Set the Git namespace.  See linkgit:gitnamespaces[7] for more
J
Josh Triplett 已提交
433 434 435
	details.  Equivalent to setting the `GIT_NAMESPACE` environment
	variable.

436
--bare::
437 438 439 440
	Treat the repository as a bare repository.  If GIT_DIR
	environment is not set, it is set to the current working
	directory.

441
--no-replace-objects::
442
	Do not use replacement refs to replace Git objects. See
443 444
	linkgit:git-replace[1] for more information.

J
Jeff King 已提交
445 446 447 448 449
--literal-pathspecs::
	Treat pathspecs literally, rather than as glob patterns. This is
	equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
	variable to `1`.

450

451 452
GIT COMMANDS
------------
453

454
We divide Git into high level ("porcelain") commands and low level
455
("plumbing") commands.
456

457 458 459 460 461 462 463 464
High-level commands (porcelain)
-------------------------------

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

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
465

466
include::cmds-mainporcelain.txt[]
467

468
Ancillary Commands
469
~~~~~~~~~~~~~~~~~~
470 471
Manipulators:

472
include::cmds-ancillarymanipulators.txt[]
473

474
Interrogators:
475

476
include::cmds-ancillaryinterrogators.txt[]
477

478 479 480 481 482 483 484 485 486 487

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

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

include::cmds-foreignscminterface.txt[]


488 489 490
Low-level commands (plumbing)
-----------------------------

491
Although Git includes its
492 493
own porcelain layer, its low-level commands are sufficient to support
development of alternative porcelains.  Developers of such porcelains
494 495
might start by reading about linkgit:git-update-index[1] and
linkgit:git-read-tree[1].
496

497 498 499 500 501 502 503 504 505
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
506 507 508 509
the repository, index, and working tree), commands that interrogate and
compare objects, and commands that move objects and references between
repositories.

510

511 512 513
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

514
include::cmds-plumbingmanipulators.txt[]
515 516 517 518 519


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

520
include::cmds-plumbinginterrogators.txt[]
521 522 523 524 525 526 527 528

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


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

529
include::cmds-synchingrepositories.txt[]
530

531
The following are helper commands used by the above; end users
532 533 534 535 536 537 538 539 540 541 542 543 544
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[]

545

J
Junio C Hamano 已提交
546 547 548
Configuration Mechanism
-----------------------

549 550 551
Git uses a simple text format to store customizations that are per
repository and are per user.  Such a configuration file may look
like this:
J
Junio C Hamano 已提交
552 553 554

------------
#
J
Junio C Hamano 已提交
555
# A '#' or ';' character indicates a comment.
J
Junio C Hamano 已提交
556 557 558 559 560 561 562 563 564 565
#

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

; user identity
[user]
	name = "Junio C Hamano"
566
	email = "gitster@pobox.com"
J
Junio C Hamano 已提交
567 568 569 570

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

Various commands read from the configuration file and adjust
571
their operation accordingly.  See linkgit:git-config[1] for a
572
list and more details about the configuration mechanism.
J
Junio C Hamano 已提交
573 574


575
Identifier Terminology
576 577
----------------------
<object>::
J
Junio C Hamano 已提交
578
	Indicates the object name for any type of object.
579 580

<blob>::
J
Junio C Hamano 已提交
581
	Indicates a blob object name.
582 583

<tree>::
J
Junio C Hamano 已提交
584
	Indicates a tree object name.
585 586

<commit>::
J
Junio C Hamano 已提交
587
	Indicates a commit object name.
588 589

<tree-ish>::
J
Junio C Hamano 已提交
590
	Indicates a tree, commit or tag object name.  A
591 592 593
	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>.
594

595 596 597 598 599 600
<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>.

601 602
<type>::
	Indicates that an object type is required.
J
Junio C Hamano 已提交
603
	Currently one of: `blob`, `tree`, `commit`, or `tag`.
604 605

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

609 610
Symbolic Identifiers
--------------------
611
Any Git command accepting any <object> can also use the following
612
symbolic notation:
613 614

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

617
<tag>::
J
Junio C Hamano 已提交
618
	a valid tag 'name'
619
	(i.e. a `refs/tags/<tag>` reference).
J
Junio C Hamano 已提交
620

621
<head>::
J
Junio C Hamano 已提交
622
	a valid head 'name'
623
	(i.e. a `refs/heads/<head>` reference).
J
Junio C Hamano 已提交
624

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

628 629 630 631

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

632
Please see the linkgit:gitrepository-layout[5] document.
633

634
Read linkgit:githooks[5] for more details about each hook.
635

636
Higher level SCMs may provide and manage additional information in the
J
Junio C Hamano 已提交
637
`$GIT_DIR`.
638

J
Junio C Hamano 已提交
639

640 641
Terminology
-----------
642
Please see linkgit:gitglossary[7].
643 644 645 646


Environment Variables
---------------------
647
Various Git commands use the following environment variables:
648

649
The Git Repository
650
~~~~~~~~~~~~~~~~~~
651
These environment variables apply to 'all' core Git commands. Nb: it
652
is worth noting that they may be used/overridden by SCMS sitting above
653
Git so take care if using Cogito etc.
654 655 656

'GIT_INDEX_FILE'::
	This environment allows the specification of an alternate
657 658
	index file. If not specified, the default of `$GIT_DIR/index`
	is used.
659 660 661 662 663 664 665 666

'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'::
667
	Due to the immutable nature of Git objects, old objects can be
668
	archived into shared, read-only directories. This variable
669
	specifies a ":" separated (on Windows ";" separated) list
670
	of Git object directories which can be used to search for Git
671
	objects. New objects will not be written to these directories.
672 673

'GIT_DIR'::
J
Junio C Hamano 已提交
674 675 676
	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.
677
	The '--git-dir' command-line option also sets this value.
678

679 680 681 682 683 684 685
'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 已提交
686
'GIT_NAMESPACE'::
687
	Set the Git namespace; see linkgit:gitnamespaces[7] for details.
J
Josh Triplett 已提交
688 689
	The '--namespace' command-line option also sets this value.

690
'GIT_CEILING_DIRECTORIES'::
691
	This should be a colon-separated list of absolute paths.  If
692
	set, it is a list of directories that Git should not chdir up
693 694 695 696 697 698 699 700 701 702 703
	into while looking for a repository directory (useful for
	excluding slow-loading network directories).  It will not
	exclude the current working directory or a GIT_DIR set on the
	command line or in the environment.  Normally, Git has to read
	the entries in this list and resolve any symlink that
	might be present in order to compare them with the current
	directory.  However, if even this access is slow, you
	can add an empty entry to the list to tell Git that the
	subsequent entries are not symlinks and needn't be resolved;
	e.g.,
	'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
704

705
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
706
	When run in a directory that does not have ".git" repository
707
	directory, Git tries to find such a directory in the parent
708 709
	directories to find the top of the working tree, but by default it
	does not cross filesystem boundaries.  This environment variable
710
	can be set to true to tell Git not to stop at filesystem
711 712 713
	boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
	an explicit repository directory set via 'GIT_DIR' or on the
	command line.
714

715
Git Commits
716 717 718 719 720 721
~~~~~~~~~~~
'GIT_AUTHOR_NAME'::
'GIT_AUTHOR_EMAIL'::
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
722
'GIT_COMMITTER_DATE'::
723
'EMAIL'::
724
	see linkgit:git-commit-tree[1]
725

726
Git Diffs
727
~~~~~~~~~
728
'GIT_DIFF_OPTS'::
729 730 731
	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
732
	value passed on the Git diff command line.
733

734
'GIT_EXTERNAL_DIFF'::
735 736 737 738 739 740 741 742 743 744 745
	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>,
746
	<old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
747 748 749 750 751 752 753 754 755 756
	<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>.
757

758 759
other
~~~~~
J
Jakub Narebski 已提交
760 761 762
'GIT_MERGE_VERBOSITY'::
	A number controlling the amount of output shown by
	the recursive merge strategy.  Overrides merge.verbosity.
763
	See linkgit:git-merge[1]
J
Jakub Narebski 已提交
764

765
'GIT_PAGER'::
766
	This environment variable overrides `$PAGER`. If it is set
767
	to an empty string or to the value "cat", Git will not launch
768 769
	a pager.  See also the `core.pager` option in
	linkgit:git-config[1].
770

771 772
'GIT_EDITOR'::
	This environment variable overrides `$EDITOR` and `$VISUAL`.
773
	It is used by several Git commands when, on interactive mode,
774 775 776
	an editor is to be launched. See also linkgit:git-var[1]
	and the `core.editor` option in linkgit:git-config[1].

777
'GIT_SSH'::
778 779
	If this environment variable is set then 'git fetch'
	and 'git push' will use this command instead
780
	of 'ssh' when they need to connect to a remote system.
D
Dan Bornstein 已提交
781 782 783 784 785 786
	The '$GIT_SSH' command will be given exactly two or
	four arguments: the 'username@host' (or just 'host')
	from the URL and the shell command to execute on that
	remote system, optionally preceded by '-p' (literally) and
	the 'port' from the URL when it specifies something other
	than the default SSH port.
787 788 789 790 791 792 793 794 795
+
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.

796
'GIT_ASKPASS'::
797
	If this environment variable is set, then Git commands which need to
798 799 800 801 802
	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].

803 804 805 806 807 808 809 810
'GIT_CONFIG_NOSYSTEM'::
	Whether to skip reading settings from the system-wide
	`$(prefix)/etc/gitconfig` file.  This environment variable can
	be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
	predictable environment for a picky script, or you can set it
	temporarily to avoid using a buggy `/etc/gitconfig` file while
	waiting for someone with sufficient permissions to fix it.

811 812
'GIT_FLUSH'::
	If this environment variable is set to "1", then commands such
813
	as 'git blame' (in incremental mode), 'git rev-list', 'git log',
814 815 816
	'git check-attr', 'git check-ignore', and 'git whatchanged' will
	force a flush of the output stream after each record have been
	flushed. If this
817 818
	variable is set to "0", the output of these commands will be done
	using completely buffered I/O.   If this environment variable is
819
	not set, Git will choose buffered or record-oriented flushing
820 821
	based on whether stdout appears to be redirected to a file or not.

822
'GIT_TRACE'::
823
	If this variable is set to "1", "2" or "true" (comparison
824
	is case insensitive), Git will print `trace:` messages on
825 826
	stderr telling about alias expansion, built-in command
	execution and external command execution.
827
	If this variable is set to an integer value greater than 1
828
	and lower than 10 (strictly) then Git will interpret this
829 830 831
	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
832
	(starting with a '/' character), Git will interpret this
833 834
	as a file path and will try to write the trace messages
	into it.
835

J
Jeff King 已提交
836
GIT_LITERAL_PATHSPECS::
837
	Setting this variable to `1` will cause Git to treat all
J
Jeff King 已提交
838 839 840 841
	pathspecs literally, rather than as glob patterns. For example,
	running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
	for commits that touch the path `*.c`, not any paths that the
	glob `*.c` matches. You might want this if you are feeding
842
	literal paths to Git (e.g., paths previously given to you by
J
Jeff King 已提交
843 844 845
	`git ls-tree`, `--raw` diff output, etc).


J
Junio C Hamano 已提交
846 847
Discussion[[Discussion]]
------------------------
848 849

More detail on the following is available from the
850
link:user-manual.html#git-concepts[Git concepts chapter of the
851
user-manual] and linkgit:gitcore-tutorial[7].
852

853
A Git project normally consists of a working directory with a ".git"
854 855 856 857 858 859 860 861
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 已提交
862
directory hierarchies; and commits, which each reference a single tree
863 864 865 866 867 868 869
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.

870
All objects are named by the SHA-1 hash of their contents, normally
871 872 873 874 875 876 877 878 879
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
880 881 882
may contain the SHA-1 name of an object or the name of another ref.  Refs
with names beginning `ref/head/` contain the SHA-1 name of the most
recent commit (or "head") of a branch under development.  SHA-1 names of
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
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.
898

899 900 901 902
FURTHER DOCUMENTATION
---------------------

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

906
The link:user-manual.html#git-concepts[Git concepts chapter of the
907
user-manual] and linkgit:gitcore-tutorial[7] both provide
908
introductions to the underlying Git architecture.
909 910 911 912 913 914 915

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
916
link:technical/api-index.html[Git API documentation].
917 918 919 920 921

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


922 923
Authors
-------
924
Git was started by Linus Torvalds, and is currently maintained by Junio
925
C Hamano. Numerous contributions have come from the Git mailing list
926 927 928 929
<git@vger.kernel.org>.  http://www.ohloh.net/p/git/contributors/summary
gives you a more complete list of contributors.

If you have a clone of git.git itself, the
930 931
output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
the authors for specific parts of the project.
932

J
Junio C Hamano 已提交
933 934 935 936 937 938 939
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.

940 941 942
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
943
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
944
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
945 946
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7]
947

948 949
GIT
---
950
Part of the linkgit:git[1] suite