git.txt 28.9 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 47 48 49 50
* link:v1.8.1/git.html[documentation for release 1.8.1]

* release notes for
  link:RelNotes/1.8.1.txt[1.8.1].

J
Junio C Hamano 已提交
51
* link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
J
Junio C Hamano 已提交
52 53

* release notes for
J
Junio C Hamano 已提交
54
  link:RelNotes/1.8.0.3.txt[1.8.0.3],
J
Junio C Hamano 已提交
55
  link:RelNotes/1.8.0.2.txt[1.8.0.2],
J
Junio C Hamano 已提交
56 57
  link:RelNotes/1.8.0.1.txt[1.8.0.1],
  link:RelNotes/1.8.0.txt[1.8.0].
J
Junio C Hamano 已提交
58

J
Junio C Hamano 已提交
59
* link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
J
Junio C Hamano 已提交
60 61

* release notes for
J
Junio C Hamano 已提交
62
  link:RelNotes/1.7.12.4.txt[1.7.12.4],
J
Junio C Hamano 已提交
63
  link:RelNotes/1.7.12.3.txt[1.7.12.3],
J
Junio C Hamano 已提交
64
  link:RelNotes/1.7.12.2.txt[1.7.12.2],
J
Junio C Hamano 已提交
65
  link:RelNotes/1.7.12.1.txt[1.7.12.1],
J
Junio C Hamano 已提交
66 67
  link:RelNotes/1.7.12.txt[1.7.12].

J
Junio C Hamano 已提交
68
* link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
J
Junio C Hamano 已提交
69 70

* release notes for
J
Junio C Hamano 已提交
71
  link:RelNotes/1.7.11.7.txt[1.7.11.7],
J
Junio C Hamano 已提交
72
  link:RelNotes/1.7.11.6.txt[1.7.11.6],
J
Junio C Hamano 已提交
73
  link:RelNotes/1.7.11.5.txt[1.7.11.5],
J
Junio C Hamano 已提交
74
  link:RelNotes/1.7.11.4.txt[1.7.11.4],
J
Junio C Hamano 已提交
75
  link:RelNotes/1.7.11.3.txt[1.7.11.3],
J
Junio C Hamano 已提交
76
  link:RelNotes/1.7.11.2.txt[1.7.11.2],
J
Junio C Hamano 已提交
77
  link:RelNotes/1.7.11.1.txt[1.7.11.1],
J
Junio C Hamano 已提交
78 79
  link:RelNotes/1.7.11.txt[1.7.11].

J
Junio C Hamano 已提交
80
* link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
J
Junio C Hamano 已提交
81 82

* release notes for
J
Junio C Hamano 已提交
83
  link:RelNotes/1.7.10.5.txt[1.7.10.5],
J
Junio C Hamano 已提交
84
  link:RelNotes/1.7.10.4.txt[1.7.10.4],
J
Junio C Hamano 已提交
85
  link:RelNotes/1.7.10.3.txt[1.7.10.3],
J
Junio C Hamano 已提交
86
  link:RelNotes/1.7.10.2.txt[1.7.10.2],
J
Junio C Hamano 已提交
87
  link:RelNotes/1.7.10.1.txt[1.7.10.1],
J
Junio C Hamano 已提交
88 89
  link:RelNotes/1.7.10.txt[1.7.10].

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

* release notes for
J
Junio C Hamano 已提交
93
  link:RelNotes/1.7.9.7.txt[1.7.9.7],
J
Junio C Hamano 已提交
94
  link:RelNotes/1.7.9.6.txt[1.7.9.6],
J
Junio C Hamano 已提交
95
  link:RelNotes/1.7.9.5.txt[1.7.9.5],
J
Junio C Hamano 已提交
96
  link:RelNotes/1.7.9.4.txt[1.7.9.4],
J
Junio C Hamano 已提交
97
  link:RelNotes/1.7.9.3.txt[1.7.9.3],
J
Junio C Hamano 已提交
98
  link:RelNotes/1.7.9.2.txt[1.7.9.2],
J
Junio C Hamano 已提交
99
  link:RelNotes/1.7.9.1.txt[1.7.9.1],
J
Junio C Hamano 已提交
100 101
  link:RelNotes/1.7.9.txt[1.7.9].

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

* release notes for
J
Junio C Hamano 已提交
105
  link:RelNotes/1.7.8.6.txt[1.7.8.6],
J
Junio C Hamano 已提交
106
  link:RelNotes/1.7.8.5.txt[1.7.8.5],
J
Junio C Hamano 已提交
107
  link:RelNotes/1.7.8.4.txt[1.7.8.4],
J
Junio C Hamano 已提交
108 109 110
  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 已提交
111 112
  link:RelNotes/1.7.8.txt[1.7.8].

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

* release notes for
J
Junio C Hamano 已提交
116
  link:RelNotes/1.7.7.7.txt[1.7.7.7],
J
Junio C Hamano 已提交
117
  link:RelNotes/1.7.7.6.txt[1.7.7.6],
J
Junio C Hamano 已提交
118 119 120 121
  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 已提交
122
  link:RelNotes/1.7.7.1.txt[1.7.7.1],
J
Junio C Hamano 已提交
123 124
  link:RelNotes/1.7.7.txt[1.7.7].

J
Junio C Hamano 已提交
125
* link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
J
Junio C Hamano 已提交
126 127

* release notes for
J
Junio C Hamano 已提交
128
  link:RelNotes/1.7.6.6.txt[1.7.6.6],
J
Junio C Hamano 已提交
129
  link:RelNotes/1.7.6.5.txt[1.7.6.5],
J
Junio C Hamano 已提交
130
  link:RelNotes/1.7.6.4.txt[1.7.6.4],
J
Junio C Hamano 已提交
131
  link:RelNotes/1.7.6.3.txt[1.7.6.3],
J
Junio C Hamano 已提交
132 133
  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 已提交
134 135
  link:RelNotes/1.7.6.txt[1.7.6].

J
Junio C Hamano 已提交
136
* link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
J
Junio C Hamano 已提交
137 138

* release notes for
J
Junio C Hamano 已提交
139
  link:RelNotes/1.7.5.4.txt[1.7.5.4],
J
Junio C Hamano 已提交
140
  link:RelNotes/1.7.5.3.txt[1.7.5.3],
J
Junio C Hamano 已提交
141
  link:RelNotes/1.7.5.2.txt[1.7.5.2],
J
Junio C Hamano 已提交
142
  link:RelNotes/1.7.5.1.txt[1.7.5.1],
J
Junio C Hamano 已提交
143 144
  link:RelNotes/1.7.5.txt[1.7.5].

J
Junio C Hamano 已提交
145
* link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
J
Junio C Hamano 已提交
146 147

* release notes for
J
Junio C Hamano 已提交
148
  link:RelNotes/1.7.4.5.txt[1.7.4.5],
J
Junio C Hamano 已提交
149
  link:RelNotes/1.7.4.4.txt[1.7.4.4],
J
Junio C Hamano 已提交
150 151
  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 已提交
152
  link:RelNotes/1.7.4.1.txt[1.7.4.1],
J
Junio C Hamano 已提交
153 154
  link:RelNotes/1.7.4.txt[1.7.4].

J
Junio C Hamano 已提交
155
* link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
J
Junio C Hamano 已提交
156 157

* release notes for
J
Junio C Hamano 已提交
158
  link:RelNotes/1.7.3.5.txt[1.7.3.5],
J
Junio C Hamano 已提交
159
  link:RelNotes/1.7.3.4.txt[1.7.3.4],
160
  link:RelNotes/1.7.3.3.txt[1.7.3.3],
J
Junio C Hamano 已提交
161
  link:RelNotes/1.7.3.2.txt[1.7.3.2],
J
Junio C Hamano 已提交
162
  link:RelNotes/1.7.3.1.txt[1.7.3.1],
J
Junio C Hamano 已提交
163 164
  link:RelNotes/1.7.3.txt[1.7.3].

165
* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
J
Junio C Hamano 已提交
166 167

* release notes for
168
  link:RelNotes/1.7.2.5.txt[1.7.2.5],
169
  link:RelNotes/1.7.2.4.txt[1.7.2.4],
170 171 172 173
  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 已提交
174

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

* release notes for
178
  link:RelNotes/1.7.1.4.txt[1.7.1.4],
179
  link:RelNotes/1.7.1.3.txt[1.7.1.3],
180 181 182
  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 已提交
183

184
* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
J
Junio C Hamano 已提交
185 186

* release notes for
187
  link:RelNotes/1.7.0.9.txt[1.7.0.9],
188
  link:RelNotes/1.7.0.8.txt[1.7.0.8],
189 190 191 192 193 194 195 196
  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 已提交
197

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

* release notes for
201
  link:RelNotes/1.6.6.3.txt[1.6.6.3],
202 203 204
  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 已提交
205

206
* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
J
Junio C Hamano 已提交
207 208

* release notes for
209
  link:RelNotes/1.6.5.9.txt[1.6.5.9],
210 211 212 213 214 215 216 217 218
  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 已提交
219

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

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

J
Junio C Hamano 已提交
230
* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
231 232

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

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

J
Junio C Hamano 已提交
247
* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
J
Junio C Hamano 已提交
248 249

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

255
* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
J
Junio C Hamano 已提交
256 257

* release notes for
258 259 260 261 262 263 264
  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 已提交
265

266
* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
J
Junio C Hamano 已提交
267 268

* release notes for
269 270 271 272 273 274 275
  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 已提交
276

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

* release notes for
280 281 282 283 284 285 286
  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 已提交
287

288
* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
289 290

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

J
Junio C Hamano 已提交
300
* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
301 302

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

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

J
Junio C Hamano 已提交
315
* release notes for
316 317 318 319 320 321
  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 已提交
322 323 324 325

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

* release notes for
326 327 328 329 330 331 332
  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].
333 334 335

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

J
Junio C Hamano 已提交
336
* release notes for
337 338 339 340 341 342 343
  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].
344 345 346 347 348

* 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].
349 350 351 352 353

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

endif::stalenotes[]

354 355 356
OPTIONS
-------
--version::
F
Fredrik Kuivinen 已提交
357
	Prints the git suite version that the 'git' program came from.
358 359

--help::
F
Fredrik Kuivinen 已提交
360
	Prints the synopsis and a list of the most commonly used
361 362 363
	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.
364 365
+
Other options are available to control how the manual page is
366
displayed. See linkgit:git-help[1] for more information,
367 368
because `git --help ...` is converted internally into `git
help ...`.
369

370 371 372 373 374 375
-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).

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

382
--html-path::
383 384
	Print the path, without trailing slash, where git's HTML
	documentation is installed and exit.
385

386
--man-path::
387 388
	Print the manpath (see `man(1)`) for the man pages for
	this version of git and exit.
389 390

--info-path::
391 392
	Print the path where the Info files documenting this
	version of git are installed and exit.
393

394 395
-p::
--paginate::
396 397 398 399
	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).
400

401 402 403
--no-pager::
	Do not pipe git output into a pager.

404 405
--git-dir=<path>::
	Set the path to the repository. This can also be controlled by
406 407
	setting the GIT_DIR environment variable. It can be an absolute
	path or relative path to current working directory.
408

409
--work-tree=<path>::
410 411
	Set the path to the working tree. It can be an absolute path
	or a path relative to the current working directory.
412 413
	This can also be controlled by setting the GIT_WORK_TREE
	environment variable and the core.worktree configuration
414 415
	variable (see core.worktree in linkgit:git-config[1] for a
	more detailed discussion).
416

J
Josh Triplett 已提交
417 418 419 420 421
--namespace=<path>::
	Set the git namespace.  See linkgit:gitnamespaces[7] for more
	details.  Equivalent to setting the `GIT_NAMESPACE` environment
	variable.

422
--bare::
423 424 425 426
	Treat the repository as a bare repository.  If GIT_DIR
	environment is not set, it is set to the current working
	directory.

427 428 429 430
--no-replace-objects::
	Do not use replacement refs to replace git objects. See
	linkgit:git-replace[1] for more information.

431

432 433
GIT COMMANDS
------------
434

435 436
We divide git into high level ("porcelain") commands and low level
("plumbing") commands.
437

438 439 440 441 442 443 444 445
High-level commands (porcelain)
-------------------------------

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

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
446

447
include::cmds-mainporcelain.txt[]
448

449
Ancillary Commands
450
~~~~~~~~~~~~~~~~~~
451 452
Manipulators:

453
include::cmds-ancillarymanipulators.txt[]
454

455
Interrogators:
456

457
include::cmds-ancillaryinterrogators.txt[]
458

459 460 461 462 463 464 465 466 467 468

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

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

include::cmds-foreignscminterface.txt[]


469 470 471 472 473 474
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
475 476
might start by reading about linkgit:git-update-index[1] and
linkgit:git-read-tree[1].
477

478 479 480 481 482 483 484 485 486
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
487 488 489 490
the repository, index, and working tree), commands that interrogate and
compare objects, and commands that move objects and references between
repositories.

491

492 493 494
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

495
include::cmds-plumbingmanipulators.txt[]
496 497 498 499 500


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

501
include::cmds-plumbinginterrogators.txt[]
502 503 504 505 506 507 508 509

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


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

510
include::cmds-synchingrepositories.txt[]
511

512
The following are helper commands used by the above; end users
513 514 515 516 517 518 519 520 521 522 523 524 525
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[]

526

J
Junio C Hamano 已提交
527 528 529
Configuration Mechanism
-----------------------

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

------------
#
J
Junio C Hamano 已提交
537
# A '#' or ';' character indicates a comment.
J
Junio C Hamano 已提交
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
#

; 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
553 554
their operation accordingly.  See linkgit:git-config[1] for a
list.
J
Junio C Hamano 已提交
555 556


557
Identifier Terminology
558 559
----------------------
<object>::
J
Junio C Hamano 已提交
560
	Indicates the object name for any type of object.
561 562

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

<tree>::
J
Junio C Hamano 已提交
566
	Indicates a tree object name.
567 568

<commit>::
J
Junio C Hamano 已提交
569
	Indicates a commit object name.
570 571

<tree-ish>::
J
Junio C Hamano 已提交
572
	Indicates a tree, commit or tag object name.  A
573 574 575
	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>.
576

577 578 579 580 581 582
<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>.

583 584
<type>::
	Indicates that an object type is required.
J
Junio C Hamano 已提交
585
	Currently one of: `blob`, `tree`, `commit`, or `tag`.
586 587

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

591 592
Symbolic Identifiers
--------------------
593
Any git command accepting any <object> can also use the following
594
symbolic notation:
595 596

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

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

603
<head>::
J
Junio C Hamano 已提交
604
	a valid head 'name'
605
	(i.e. a `refs/heads/<head>` reference).
J
Junio C Hamano 已提交
606

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

610 611 612 613

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

614
Please see the linkgit:gitrepository-layout[5] document.
615

616
Read linkgit:githooks[5] for more details about each hook.
617

618
Higher level SCMs may provide and manage additional information in the
J
Junio C Hamano 已提交
619
`$GIT_DIR`.
620

J
Junio C Hamano 已提交
621

622 623
Terminology
-----------
624
Please see linkgit:gitglossary[7].
625 626 627 628 629 630


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

631 632 633 634
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 已提交
635
git so take care if using Cogito etc.
636 637 638

'GIT_INDEX_FILE'::
	This environment allows the specification of an alternate
639 640
	index file. If not specified, the default of `$GIT_DIR/index`
	is used.
641 642 643 644 645 646 647 648 649 650

'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
651 652 653
	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.
654 655

'GIT_DIR'::
J
Junio C Hamano 已提交
656 657 658
	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.
659
	The '--git-dir' command-line option also sets this value.
660

661 662 663 664 665 666 667
'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 已提交
668 669 670 671
'GIT_NAMESPACE'::
	Set the git namespace; see linkgit:gitnamespaces[7] for details.
	The '--namespace' command-line option also sets this value.

672 673 674 675 676 677 678 679
'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.)

680
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
681 682 683 684
	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
685 686 687 688
	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.
689

690 691 692 693 694 695 696
git Commits
~~~~~~~~~~~
'GIT_AUTHOR_NAME'::
'GIT_AUTHOR_EMAIL'::
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
697
'GIT_COMMITTER_DATE'::
698
'EMAIL'::
699
	see linkgit:git-commit-tree[1]
700 701 702

git Diffs
~~~~~~~~~
703
'GIT_DIFF_OPTS'::
704 705 706 707 708
	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.

709
'GIT_EXTERNAL_DIFF'::
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
	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>.
732

733 734
other
~~~~~
J
Jakub Narebski 已提交
735 736 737
'GIT_MERGE_VERBOSITY'::
	A number controlling the amount of output shown by
	the recursive merge strategy.  Overrides merge.verbosity.
738
	See linkgit:git-merge[1]
J
Jakub Narebski 已提交
739

740
'GIT_PAGER'::
741 742
	This environment variable overrides `$PAGER`. If it is set
	to an empty string or to the value "cat", git will not launch
743 744
	a pager.  See also the `core.pager` option in
	linkgit:git-config[1].
745

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

752
'GIT_SSH'::
753 754
	If this environment variable is set then 'git fetch'
	and 'git push' will use this command instead
755
	of 'ssh' when they need to connect to a remote system.
756
	The '$GIT_SSH' command will be given exactly two arguments:
757 758 759 760 761 762 763 764 765 766 767
	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.

768 769 770 771 772 773 774
'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].

775 776 777 778 779 780 781 782
'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.

783 784
'GIT_FLUSH'::
	If this environment variable is set to "1", then commands such
785 786
	as 'git blame' (in incremental mode), 'git rev-list', 'git log',
	and 'git whatchanged' will force a flush of the output stream
787 788 789 790 791 792
	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.

793
'GIT_TRACE'::
794 795
	If this variable is set to "1", "2" or "true" (comparison
	is case insensitive), git will print `trace:` messages on
796 797
	stderr telling about alias expansion, built-in command
	execution and external command execution.
798 799 800 801 802 803 804 805
	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.
806

J
Junio C Hamano 已提交
807 808
Discussion[[Discussion]]
------------------------
809 810 811

More detail on the following is available from the
link:user-manual.html#git-concepts[git concepts chapter of the
812
user-manual] and linkgit:gitcore-tutorial[7].
813 814 815 816 817 818 819 820 821 822

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 已提交
823
directory hierarchies; and commits, which each reference a single tree
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
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 已提交
843
recent commit (or "head") of a branch under development.  SHA1 names of
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
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.
859

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
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].


883 884
Authors
-------
885 886
Git was started by Linus Torvalds, and is currently maintained by Junio
C Hamano. Numerous contributions have come from the git mailing list
887 888 889 890
<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
891 892
output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
the authors for specific parts of the project.
893

J
Junio C Hamano 已提交
894 895 896 897 898 899 900
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.

901 902 903
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
904
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
905
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
906 907
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7]
908

909 910
GIT
---
911
Part of the linkgit:git[1] suite