]>
Commit | Line | Data |
---|---|---|
9e1f0a85 | 1 | git(1) |
2cf565c5 | 2 | ====== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
6 | git - the stupid content tracker | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
8b70004b | 11 | [verse] |
f2dd8c37 | 12 | 'git' [--version] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path] |
b0fa7ab5 | 13 | [-p|--paginate|--no-pager] [--no-replace-objects] |
62b4698e ŠN |
14 | [--bare] [--git-dir=<path>] [--work-tree=<path>] |
15 | [-c <name>=<value>] | |
16 | [--help] <command> [<args>] | |
2cf565c5 DG |
17 | |
18 | DESCRIPTION | |
19 | ----------- | |
23091e95 BF |
20 | Git is a fast, scalable, distributed revision control system with an |
21 | unusually rich command set that provides both high-level operations | |
22 | and full access to internals. | |
23 | ||
6998e4db | 24 | See linkgit:gittutorial[7] to get started, then see |
23091e95 BF |
25 | link:everyday.html[Everyday Git] for a useful minimum set of commands, and |
26 | "man git-commandname" for documentation of each command. CVS users may | |
6998e4db JN |
27 | also want to read linkgit:gitcvs-migration[7]. See |
28 | the link:user-manual.html[Git User's Manual] for a more in-depth | |
a1dc34fa | 29 | introduction. |
cb22bc44 | 30 | |
62b4698e | 31 | The '<command>' is either a name of a Git command (see below) or an alias |
5162e697 | 32 | as defined in the configuration file (see linkgit:git-config[1]). |
4514ad4f | 33 | |
34b604af JA |
34 | Formatted and hyperlinked version of the latest git |
35 | documentation can be viewed at | |
36 | `http://www.kernel.org/pub/software/scm/git/docs/`. | |
37 | ||
26cfcfbf JH |
38 | ifdef::stalenotes[] |
39 | [NOTE] | |
40 | ============ | |
26cfcfbf | 41 | |
2ff3f61a JH |
42 | You are reading the documentation for the latest (possibly |
43 | unreleased) version of git, that is available from 'master' | |
44 | branch of the `git.git` repository. | |
45 | Documentation for older releases are available here: | |
43a8e4fe | 46 | |
740a8fc2 | 47 | * link:v1.7.6.3/git.html[documentation for release 1.7.6.3] |
f696543d JH |
48 | |
49 | * release notes for | |
740a8fc2 | 50 | link:RelNotes/1.7.6.3.txt[1.7.6.3], |
509d5970 JH |
51 | link:RelNotes/1.7.6.2.txt[1.7.6.2], |
52 | link:RelNotes/1.7.6.1.txt[1.7.6.1], | |
f696543d JH |
53 | link:RelNotes/1.7.6.txt[1.7.6]. |
54 | ||
e5af0de2 | 55 | * link:v1.7.5.4/git.html[documentation for release 1.7.5.4] |
ec014eac JH |
56 | |
57 | * release notes for | |
e5af0de2 | 58 | link:RelNotes/1.7.5.4.txt[1.7.5.4], |
3c3e0b3c | 59 | link:RelNotes/1.7.5.3.txt[1.7.5.3], |
3d5ae435 | 60 | link:RelNotes/1.7.5.2.txt[1.7.5.2], |
2f312e88 | 61 | link:RelNotes/1.7.5.1.txt[1.7.5.1], |
ec014eac JH |
62 | link:RelNotes/1.7.5.txt[1.7.5]. |
63 | ||
6ceb270c | 64 | * link:v1.7.4.5/git.html[documentation for release 1.7.4.5] |
7ed863a8 JH |
65 | |
66 | * release notes for | |
6ceb270c | 67 | link:RelNotes/1.7.4.5.txt[1.7.4.5], |
6be05591 | 68 | link:RelNotes/1.7.4.4.txt[1.7.4.4], |
cb35c064 JH |
69 | link:RelNotes/1.7.4.3.txt[1.7.4.3], |
70 | link:RelNotes/1.7.4.2.txt[1.7.4.2], | |
9971d6d5 | 71 | link:RelNotes/1.7.4.1.txt[1.7.4.1], |
7ed863a8 JH |
72 | link:RelNotes/1.7.4.txt[1.7.4]. |
73 | ||
685e9d91 | 74 | * link:v1.7.3.5/git.html[documentation for release 1.7.3.5] |
87b50542 JH |
75 | |
76 | * release notes for | |
685e9d91 | 77 | link:RelNotes/1.7.3.5.txt[1.7.3.5], |
15368e18 | 78 | link:RelNotes/1.7.3.4.txt[1.7.3.4], |
ed94cc76 | 79 | link:RelNotes/1.7.3.3.txt[1.7.3.3], |
8a904385 | 80 | link:RelNotes/1.7.3.2.txt[1.7.3.2], |
92c1e717 | 81 | link:RelNotes/1.7.3.1.txt[1.7.3.1], |
87b50542 JH |
82 | link:RelNotes/1.7.3.txt[1.7.3]. |
83 | ||
1b974346 | 84 | * link:v1.7.2.5/git.html[documentation for release 1.7.2.5] |
64fdc08d JH |
85 | |
86 | * release notes for | |
1b974346 | 87 | link:RelNotes/1.7.2.5.txt[1.7.2.5], |
ed94cc76 | 88 | link:RelNotes/1.7.2.4.txt[1.7.2.4], |
761e742d NP |
89 | link:RelNotes/1.7.2.3.txt[1.7.2.3], |
90 | link:RelNotes/1.7.2.2.txt[1.7.2.2], | |
91 | link:RelNotes/1.7.2.1.txt[1.7.2.1], | |
92 | link:RelNotes/1.7.2.txt[1.7.2]. | |
64fdc08d | 93 | |
1b974346 | 94 | * link:v1.7.1.4/git.html[documentation for release 1.7.1.4] |
d599e048 JH |
95 | |
96 | * release notes for | |
1b974346 | 97 | link:RelNotes/1.7.1.4.txt[1.7.1.4], |
ed94cc76 | 98 | link:RelNotes/1.7.1.3.txt[1.7.1.3], |
761e742d NP |
99 | link:RelNotes/1.7.1.2.txt[1.7.1.2], |
100 | link:RelNotes/1.7.1.1.txt[1.7.1.1], | |
101 | link:RelNotes/1.7.1.txt[1.7.1]. | |
d599e048 | 102 | |
1b974346 | 103 | * link:v1.7.0.9/git.html[documentation for release 1.7.0.9] |
e923eaeb JH |
104 | |
105 | * release notes for | |
1b974346 | 106 | link:RelNotes/1.7.0.9.txt[1.7.0.9], |
ed94cc76 | 107 | link:RelNotes/1.7.0.8.txt[1.7.0.8], |
761e742d NP |
108 | link:RelNotes/1.7.0.7.txt[1.7.0.7], |
109 | link:RelNotes/1.7.0.6.txt[1.7.0.6], | |
110 | link:RelNotes/1.7.0.5.txt[1.7.0.5], | |
111 | link:RelNotes/1.7.0.4.txt[1.7.0.4], | |
112 | link:RelNotes/1.7.0.3.txt[1.7.0.3], | |
113 | link:RelNotes/1.7.0.2.txt[1.7.0.2], | |
114 | link:RelNotes/1.7.0.1.txt[1.7.0.1], | |
115 | link:RelNotes/1.7.0.txt[1.7.0]. | |
e923eaeb | 116 | |
1b974346 | 117 | * link:v1.6.6.3/git.html[documentation for release 1.6.6.3] |
902f2353 JH |
118 | |
119 | * release notes for | |
1b974346 | 120 | link:RelNotes/1.6.6.3.txt[1.6.6.3], |
761e742d NP |
121 | link:RelNotes/1.6.6.2.txt[1.6.6.2], |
122 | link:RelNotes/1.6.6.1.txt[1.6.6.1], | |
123 | link:RelNotes/1.6.6.txt[1.6.6]. | |
902f2353 | 124 | |
1b974346 | 125 | * link:v1.6.5.9/git.html[documentation for release 1.6.5.9] |
78d553b7 JH |
126 | |
127 | * release notes for | |
1b974346 | 128 | link:RelNotes/1.6.5.9.txt[1.6.5.9], |
761e742d NP |
129 | link:RelNotes/1.6.5.8.txt[1.6.5.8], |
130 | link:RelNotes/1.6.5.7.txt[1.6.5.7], | |
131 | link:RelNotes/1.6.5.6.txt[1.6.5.6], | |
132 | link:RelNotes/1.6.5.5.txt[1.6.5.5], | |
133 | link:RelNotes/1.6.5.4.txt[1.6.5.4], | |
134 | link:RelNotes/1.6.5.3.txt[1.6.5.3], | |
135 | link:RelNotes/1.6.5.2.txt[1.6.5.2], | |
136 | link:RelNotes/1.6.5.1.txt[1.6.5.1], | |
137 | link:RelNotes/1.6.5.txt[1.6.5]. | |
78d553b7 | 138 | |
1b974346 | 139 | * link:v1.6.4.5/git.html[documentation for release 1.6.4.5] |
0a53e9dd JH |
140 | |
141 | * release notes for | |
1b974346 | 142 | link:RelNotes/1.6.4.5.txt[1.6.4.5], |
761e742d NP |
143 | link:RelNotes/1.6.4.4.txt[1.6.4.4], |
144 | link:RelNotes/1.6.4.3.txt[1.6.4.3], | |
145 | link:RelNotes/1.6.4.2.txt[1.6.4.2], | |
146 | link:RelNotes/1.6.4.1.txt[1.6.4.1], | |
147 | link:RelNotes/1.6.4.txt[1.6.4]. | |
0a53e9dd | 148 | |
441b40d8 | 149 | * link:v1.6.3.4/git.html[documentation for release 1.6.3.4] |
6096d759 JH |
150 | |
151 | * release notes for | |
761e742d NP |
152 | link:RelNotes/1.6.3.4.txt[1.6.3.4], |
153 | link:RelNotes/1.6.3.3.txt[1.6.3.3], | |
154 | link:RelNotes/1.6.3.2.txt[1.6.3.2], | |
155 | link:RelNotes/1.6.3.1.txt[1.6.3.1], | |
156 | link:RelNotes/1.6.3.txt[1.6.3]. | |
a95148de JH |
157 | |
158 | * release notes for | |
761e742d NP |
159 | link:RelNotes/1.6.2.5.txt[1.6.2.5], |
160 | link:RelNotes/1.6.2.4.txt[1.6.2.4], | |
161 | link:RelNotes/1.6.2.3.txt[1.6.2.3], | |
162 | link:RelNotes/1.6.2.2.txt[1.6.2.2], | |
163 | link:RelNotes/1.6.2.1.txt[1.6.2.1], | |
164 | link:RelNotes/1.6.2.txt[1.6.2]. | |
a95148de | 165 | |
621f1b4b | 166 | * link:v1.6.1.3/git.html[documentation for release 1.6.1.3] |
8104ebfe JH |
167 | |
168 | * release notes for | |
761e742d NP |
169 | link:RelNotes/1.6.1.3.txt[1.6.1.3], |
170 | link:RelNotes/1.6.1.2.txt[1.6.1.2], | |
171 | link:RelNotes/1.6.1.1.txt[1.6.1.1], | |
172 | link:RelNotes/1.6.1.txt[1.6.1]. | |
8104ebfe | 173 | |
efe05b01 | 174 | * link:v1.6.0.6/git.html[documentation for release 1.6.0.6] |
ea02eef0 JH |
175 | |
176 | * release notes for | |
761e742d NP |
177 | link:RelNotes/1.6.0.6.txt[1.6.0.6], |
178 | link:RelNotes/1.6.0.5.txt[1.6.0.5], | |
179 | link:RelNotes/1.6.0.4.txt[1.6.0.4], | |
180 | link:RelNotes/1.6.0.3.txt[1.6.0.3], | |
181 | link:RelNotes/1.6.0.2.txt[1.6.0.2], | |
182 | link:RelNotes/1.6.0.1.txt[1.6.0.1], | |
183 | link:RelNotes/1.6.0.txt[1.6.0]. | |
ea02eef0 | 184 | |
efe05b01 | 185 | * link:v1.5.6.6/git.html[documentation for release 1.5.6.6] |
e449f105 JH |
186 | |
187 | * release notes for | |
761e742d NP |
188 | link:RelNotes/1.5.6.6.txt[1.5.6.6], |
189 | link:RelNotes/1.5.6.5.txt[1.5.6.5], | |
190 | link:RelNotes/1.5.6.4.txt[1.5.6.4], | |
191 | link:RelNotes/1.5.6.3.txt[1.5.6.3], | |
192 | link:RelNotes/1.5.6.2.txt[1.5.6.2], | |
193 | link:RelNotes/1.5.6.1.txt[1.5.6.1], | |
194 | link:RelNotes/1.5.6.txt[1.5.6]. | |
e449f105 | 195 | |
efe05b01 | 196 | * link:v1.5.5.6/git.html[documentation for release 1.5.5.6] |
1d2375dd JH |
197 | |
198 | * release notes for | |
761e742d NP |
199 | link:RelNotes/1.5.5.6.txt[1.5.5.6], |
200 | link:RelNotes/1.5.5.5.txt[1.5.5.5], | |
201 | link:RelNotes/1.5.5.4.txt[1.5.5.4], | |
202 | link:RelNotes/1.5.5.3.txt[1.5.5.3], | |
203 | link:RelNotes/1.5.5.2.txt[1.5.5.2], | |
204 | link:RelNotes/1.5.5.1.txt[1.5.5.1], | |
205 | link:RelNotes/1.5.5.txt[1.5.5]. | |
1d2375dd | 206 | |
efe05b01 | 207 | * link:v1.5.4.7/git.html[documentation for release 1.5.4.7] |
6ce8e44a JH |
208 | |
209 | * release notes for | |
761e742d NP |
210 | link:RelNotes/1.5.4.7.txt[1.5.4.7], |
211 | link:RelNotes/1.5.4.6.txt[1.5.4.6], | |
212 | link:RelNotes/1.5.4.5.txt[1.5.4.5], | |
213 | link:RelNotes/1.5.4.4.txt[1.5.4.4], | |
214 | link:RelNotes/1.5.4.3.txt[1.5.4.3], | |
215 | link:RelNotes/1.5.4.2.txt[1.5.4.2], | |
216 | link:RelNotes/1.5.4.1.txt[1.5.4.1], | |
217 | link:RelNotes/1.5.4.txt[1.5.4]. | |
6ce8e44a | 218 | |
e708af6e | 219 | * link:v1.5.3.8/git.html[documentation for release 1.5.3.8] |
5587cac2 JH |
220 | |
221 | * release notes for | |
761e742d NP |
222 | link:RelNotes/1.5.3.8.txt[1.5.3.8], |
223 | link:RelNotes/1.5.3.7.txt[1.5.3.7], | |
224 | link:RelNotes/1.5.3.6.txt[1.5.3.6], | |
225 | link:RelNotes/1.5.3.5.txt[1.5.3.5], | |
226 | link:RelNotes/1.5.3.4.txt[1.5.3.4], | |
227 | link:RelNotes/1.5.3.3.txt[1.5.3.3], | |
228 | link:RelNotes/1.5.3.2.txt[1.5.3.2], | |
229 | link:RelNotes/1.5.3.1.txt[1.5.3.1], | |
230 | link:RelNotes/1.5.3.txt[1.5.3]. | |
b6e4db6a | 231 | |
e636106c JH |
232 | * link:v1.5.2.5/git.html[documentation for release 1.5.2.5] |
233 | ||
aba170cd | 234 | * release notes for |
761e742d NP |
235 | link:RelNotes/1.5.2.5.txt[1.5.2.5], |
236 | link:RelNotes/1.5.2.4.txt[1.5.2.4], | |
237 | link:RelNotes/1.5.2.3.txt[1.5.2.3], | |
238 | link:RelNotes/1.5.2.2.txt[1.5.2.2], | |
239 | link:RelNotes/1.5.2.1.txt[1.5.2.1], | |
240 | link:RelNotes/1.5.2.txt[1.5.2]. | |
aba170cd JH |
241 | |
242 | * link:v1.5.1.6/git.html[documentation for release 1.5.1.6] | |
243 | ||
244 | * release notes for | |
761e742d NP |
245 | link:RelNotes/1.5.1.6.txt[1.5.1.6], |
246 | link:RelNotes/1.5.1.5.txt[1.5.1.5], | |
247 | link:RelNotes/1.5.1.4.txt[1.5.1.4], | |
248 | link:RelNotes/1.5.1.3.txt[1.5.1.3], | |
249 | link:RelNotes/1.5.1.2.txt[1.5.1.2], | |
250 | link:RelNotes/1.5.1.1.txt[1.5.1.1], | |
251 | link:RelNotes/1.5.1.txt[1.5.1]. | |
2ff3f61a JH |
252 | |
253 | * link:v1.5.0.7/git.html[documentation for release 1.5.0.7] | |
254 | ||
aba170cd | 255 | * release notes for |
761e742d NP |
256 | link:RelNotes/1.5.0.7.txt[1.5.0.7], |
257 | link:RelNotes/1.5.0.6.txt[1.5.0.6], | |
258 | link:RelNotes/1.5.0.5.txt[1.5.0.5], | |
259 | link:RelNotes/1.5.0.3.txt[1.5.0.3], | |
260 | link:RelNotes/1.5.0.2.txt[1.5.0.2], | |
261 | link:RelNotes/1.5.0.1.txt[1.5.0.1], | |
262 | link:RelNotes/1.5.0.txt[1.5.0]. | |
2ff3f61a JH |
263 | |
264 | * documentation for release link:v1.4.4.4/git.html[1.4.4.4], | |
265 | link:v1.3.3/git.html[1.3.3], | |
266 | link:v1.2.6/git.html[1.2.6], | |
267 | link:v1.0.13/git.html[1.0.13]. | |
26cfcfbf JH |
268 | |
269 | ============ | |
270 | ||
271 | endif::stalenotes[] | |
272 | ||
cb22bc44 AE |
273 | OPTIONS |
274 | ------- | |
275 | --version:: | |
a87cd02c | 276 | Prints the git suite version that the 'git' program came from. |
cb22bc44 AE |
277 | |
278 | --help:: | |
a87cd02c | 279 | Prints the synopsis and a list of the most commonly used |
0f6f195b CC |
280 | commands. If the option '--all' or '-a' is given then all |
281 | available commands are printed. If a git command is named this | |
282 | option will bring up the manual page for that command. | |
45533d26 CC |
283 | + |
284 | Other options are available to control how the manual page is | |
5162e697 | 285 | displayed. See linkgit:git-help[1] for more information, |
db5d6666 JN |
286 | because `git --help ...` is converted internally into `git |
287 | help ...`. | |
cb22bc44 | 288 | |
8b1fa778 AR |
289 | -c <name>=<value>:: |
290 | Pass a configuration parameter to the command. The value | |
291 | given will override values from configuration files. | |
292 | The <name> is expected in the same format as listed by | |
293 | 'git config' (subkeys separated by dots). | |
294 | ||
62b4698e | 295 | --exec-path[=<path>]:: |
a87cd02c | 296 | Path to wherever your core git programs are installed. |
cb22bc44 | 297 | This can also be controlled by setting the GIT_EXEC_PATH |
56992f76 | 298 | environment variable. If no path is given, 'git' will print |
cb22bc44 AE |
299 | the current setting and then exit. |
300 | ||
89a56bfb | 301 | --html-path:: |
239b5ed9 JN |
302 | Print the path, without trailing slash, where git's HTML |
303 | documentation is installed and exit. | |
89a56bfb | 304 | |
f2dd8c37 | 305 | --man-path:: |
239b5ed9 JN |
306 | Print the manpath (see `man(1)`) for the man pages for |
307 | this version of git and exit. | |
f2dd8c37 JS |
308 | |
309 | --info-path:: | |
239b5ed9 JN |
310 | Print the path where the Info files documenting this |
311 | version of git are installed and exit. | |
89a56bfb | 312 | |
3240240f SB |
313 | -p:: |
314 | --paginate:: | |
06300d97 JN |
315 | Pipe all output into 'less' (or if set, $PAGER) if standard |
316 | output is a terminal. This overrides the `pager.<cmd>` | |
317 | configuration options (see the "Configuration Mechanism" section | |
318 | below). | |
6acbcb92 | 319 | |
463a849d MM |
320 | --no-pager:: |
321 | Do not pipe git output into a pager. | |
322 | ||
6acbcb92 JS |
323 | --git-dir=<path>:: |
324 | Set the path to the repository. This can also be controlled by | |
302cc11a LY |
325 | setting the GIT_DIR environment variable. It can be an absolute |
326 | path or relative path to current working directory. | |
6acbcb92 | 327 | |
892c41b9 | 328 | --work-tree=<path>:: |
ea472c1e JH |
329 | Set the path to the working tree. It can be an absolute path |
330 | or a path relative to the current working directory. | |
892c41b9 ML |
331 | This can also be controlled by setting the GIT_WORK_TREE |
332 | environment variable and the core.worktree configuration | |
ea472c1e JH |
333 | variable (see core.worktree in linkgit:git-config[1] for a |
334 | more detailed discussion). | |
892c41b9 | 335 | |
6acbcb92 | 336 | --bare:: |
9277d602 JH |
337 | Treat the repository as a bare repository. If GIT_DIR |
338 | environment is not set, it is set to the current working | |
339 | directory. | |
340 | ||
b0fa7ab5 CC |
341 | --no-replace-objects:: |
342 | Do not use replacement refs to replace git objects. See | |
343 | linkgit:git-replace[1] for more information. | |
344 | ||
9755afbd | 345 | |
23091e95 BF |
346 | FURTHER DOCUMENTATION |
347 | --------------------- | |
9755afbd | 348 | |
23091e95 BF |
349 | See the references above to get started using git. The following is |
350 | probably more detail than necessary for a first-time user. | |
8db9307c | 351 | |
40dac517 | 352 | The link:user-manual.html#git-concepts[git concepts chapter of the |
6998e4db | 353 | user-manual] and linkgit:gitcore-tutorial[7] both provide |
40dac517 | 354 | introductions to the underlying git architecture. |
e6fc2346 | 355 | |
801a011d TR |
356 | See linkgit:gitworkflows[7] for an overview of recommended workflows. |
357 | ||
23091e95 BF |
358 | See also the link:howto-index.html[howto] documents for some useful |
359 | examples. | |
9755afbd | 360 | |
6998e4db JN |
361 | The internals are documented in the |
362 | link:technical/api-index.html[GIT API documentation]. | |
530e741c | 363 | |
23091e95 BF |
364 | GIT COMMANDS |
365 | ------------ | |
9755afbd | 366 | |
23091e95 BF |
367 | We divide git into high level ("porcelain") commands and low level |
368 | ("plumbing") commands. | |
8b15e2fb | 369 | |
23091e95 BF |
370 | High-level commands (porcelain) |
371 | ------------------------------- | |
372 | ||
373 | We separate the porcelain commands into the main commands and some | |
374 | ancillary user utilities. | |
375 | ||
376 | Main porcelain commands | |
377 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 378 | |
377e8139 | 379 | include::cmds-mainporcelain.txt[] |
e31bb3bb | 380 | |
90933efb | 381 | Ancillary Commands |
23091e95 | 382 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
383 | Manipulators: |
384 | ||
377e8139 | 385 | include::cmds-ancillarymanipulators.txt[] |
204ee6a9 | 386 | |
90933efb | 387 | Interrogators: |
204ee6a9 | 388 | |
377e8139 | 389 | include::cmds-ancillaryinterrogators.txt[] |
7fc9d69f | 390 | |
89bf2077 JH |
391 | |
392 | Interacting with Others | |
393 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
394 | ||
395 | These commands are to interact with foreign SCM and with other | |
396 | people via patch over e-mail. | |
397 | ||
398 | include::cmds-foreignscminterface.txt[] | |
399 | ||
400 | ||
b1f33d62 RR |
401 | Low-level commands (plumbing) |
402 | ----------------------------- | |
403 | ||
404 | Although git includes its | |
405 | own porcelain layer, its low-level commands are sufficient to support | |
406 | development of alternative porcelains. Developers of such porcelains | |
5162e697 DM |
407 | might start by reading about linkgit:git-update-index[1] and |
408 | linkgit:git-read-tree[1]. | |
b1f33d62 | 409 | |
89bf2077 JH |
410 | The interface (input, output, set of options and the semantics) |
411 | to these low-level commands are meant to be a lot more stable | |
412 | than Porcelain level commands, because these commands are | |
413 | primarily for scripted use. The interface to Porcelain commands | |
414 | on the other hand are subject to change in order to improve the | |
415 | end user experience. | |
416 | ||
417 | The following description divides | |
418 | the low-level commands into commands that manipulate objects (in | |
b1f33d62 RR |
419 | the repository, index, and working tree), commands that interrogate and |
420 | compare objects, and commands that move objects and references between | |
421 | repositories. | |
422 | ||
89bf2077 | 423 | |
b1f33d62 RR |
424 | Manipulation commands |
425 | ~~~~~~~~~~~~~~~~~~~~~ | |
b1f33d62 | 426 | |
377e8139 | 427 | include::cmds-plumbingmanipulators.txt[] |
b1f33d62 RR |
428 | |
429 | ||
430 | Interrogation commands | |
431 | ~~~~~~~~~~~~~~~~~~~~~~ | |
432 | ||
377e8139 | 433 | include::cmds-plumbinginterrogators.txt[] |
b1f33d62 RR |
434 | |
435 | In general, the interrogate commands do not touch the files in | |
436 | the working tree. | |
437 | ||
438 | ||
439 | Synching repositories | |
440 | ~~~~~~~~~~~~~~~~~~~~~ | |
441 | ||
377e8139 | 442 | include::cmds-synchingrepositories.txt[] |
b1f33d62 | 443 | |
57f6ec02 | 444 | The following are helper commands used by the above; end users |
89bf2077 JH |
445 | typically do not use them directly. |
446 | ||
447 | include::cmds-synchelpers.txt[] | |
448 | ||
449 | ||
450 | Internal helper commands | |
451 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
452 | ||
453 | These are internal helper commands used by other commands; end | |
454 | users typically do not use them directly. | |
455 | ||
456 | include::cmds-purehelpers.txt[] | |
457 | ||
b1f33d62 | 458 | |
5773c9f2 JH |
459 | Configuration Mechanism |
460 | ----------------------- | |
461 | ||
2fa090b6 | 462 | Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file |
5773c9f2 | 463 | is used to hold per-repository configuration options. It is a |
addf88e4 | 464 | simple text file modeled after `.ini` format familiar to some |
5773c9f2 JH |
465 | people. Here is an example: |
466 | ||
467 | ------------ | |
468 | # | |
2fa090b6 | 469 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
470 | # |
471 | ||
472 | ; core variables | |
473 | [core] | |
474 | ; Don't trust file modes | |
475 | filemode = false | |
476 | ||
477 | ; user identity | |
478 | [user] | |
479 | name = "Junio C Hamano" | |
480 | email = "junkio@twinsun.com" | |
481 | ||
482 | ------------ | |
483 | ||
484 | Various commands read from the configuration file and adjust | |
06300d97 JN |
485 | their operation accordingly. See linkgit:git-config[1] for a |
486 | list. | |
5773c9f2 JH |
487 | |
488 | ||
6c84e2e0 | 489 | Identifier Terminology |
2cf565c5 DG |
490 | ---------------------- |
491 | <object>:: | |
2fa090b6 | 492 | Indicates the object name for any type of object. |
2cf565c5 DG |
493 | |
494 | <blob>:: | |
2fa090b6 | 495 | Indicates a blob object name. |
2cf565c5 DG |
496 | |
497 | <tree>:: | |
2fa090b6 | 498 | Indicates a tree object name. |
2cf565c5 DG |
499 | |
500 | <commit>:: | |
2fa090b6 | 501 | Indicates a commit object name. |
2cf565c5 DG |
502 | |
503 | <tree-ish>:: | |
2fa090b6 | 504 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
505 | command that takes a <tree-ish> argument ultimately wants to |
506 | operate on a <tree> object but automatically dereferences | |
507 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 | 508 | |
043d7605 TT |
509 | <commit-ish>:: |
510 | Indicates a commit or tag object name. A | |
511 | command that takes a <commit-ish> argument ultimately wants to | |
512 | operate on a <commit> object but automatically dereferences | |
513 | <tag> objects that point at a <commit>. | |
514 | ||
2cf565c5 DG |
515 | <type>:: |
516 | Indicates that an object type is required. | |
2fa090b6 | 517 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
518 | |
519 | <file>:: | |
2fa090b6 JH |
520 | Indicates a filename - almost always relative to the |
521 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 522 | |
c1bdacf9 DG |
523 | Symbolic Identifiers |
524 | -------------------- | |
90933efb | 525 | Any git command accepting any <object> can also use the following |
6c84e2e0 | 526 | symbolic notation: |
c1bdacf9 DG |
527 | |
528 | HEAD:: | |
0abcfbff | 529 | indicates the head of the current branch. |
2fa090b6 | 530 | |
c1bdacf9 | 531 | <tag>:: |
2fa090b6 | 532 | a valid tag 'name' |
0abcfbff | 533 | (i.e. a `refs/tags/<tag>` reference). |
2fa090b6 | 534 | |
c1bdacf9 | 535 | <head>:: |
2fa090b6 | 536 | a valid head 'name' |
0abcfbff | 537 | (i.e. a `refs/heads/<head>` reference). |
2fa090b6 | 538 | |
d47107d8 | 539 | For a more complete list of ways to spell object names, see |
9d83e382 | 540 | "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7]. |
d47107d8 | 541 | |
c1bdacf9 DG |
542 | |
543 | File/Directory Structure | |
544 | ------------------------ | |
c1bdacf9 | 545 | |
6998e4db | 546 | Please see the linkgit:gitrepository-layout[5] document. |
c1bdacf9 | 547 | |
6998e4db | 548 | Read linkgit:githooks[5] for more details about each hook. |
6250ad1e | 549 | |
c1bdacf9 | 550 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 551 | `$GIT_DIR`. |
c1bdacf9 | 552 | |
a1d4aa74 | 553 | |
2cf565c5 DG |
554 | Terminology |
555 | ----------- | |
6998e4db | 556 | Please see linkgit:gitglossary[7]. |
2cf565c5 DG |
557 | |
558 | ||
559 | Environment Variables | |
560 | --------------------- | |
561 | Various git commands use the following environment variables: | |
562 | ||
c1bdacf9 DG |
563 | The git Repository |
564 | ~~~~~~~~~~~~~~~~~~ | |
565 | These environment variables apply to 'all' core git commands. Nb: it | |
566 | is worth noting that they may be used/overridden by SCMS sitting above | |
2fa090b6 | 567 | git so take care if using Cogito etc. |
c1bdacf9 DG |
568 | |
569 | 'GIT_INDEX_FILE':: | |
570 | This environment allows the specification of an alternate | |
5f3aa197 LS |
571 | index file. If not specified, the default of `$GIT_DIR/index` |
572 | is used. | |
c1bdacf9 DG |
573 | |
574 | 'GIT_OBJECT_DIRECTORY':: | |
575 | If the object storage directory is specified via this | |
576 | environment variable then the sha1 directories are created | |
577 | underneath - otherwise the default `$GIT_DIR/objects` | |
578 | directory is used. | |
579 | ||
580 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
581 | Due to the immutable nature of git objects, old objects can be | |
582 | archived into shared, read-only directories. This variable | |
80ba074f JS |
583 | specifies a ":" separated (on Windows ";" separated) list |
584 | of git object directories which can be used to search for git | |
585 | objects. New objects will not be written to these directories. | |
c1bdacf9 DG |
586 | |
587 | 'GIT_DIR':: | |
2fa090b6 JH |
588 | If the 'GIT_DIR' environment variable is set then it |
589 | specifies a path to use instead of the default `.git` | |
590 | for the base of the repository. | |
c1bdacf9 | 591 | |
892c41b9 ML |
592 | 'GIT_WORK_TREE':: |
593 | Set the path to the working tree. The value will not be | |
594 | used in combination with repositories found automatically in | |
595 | a .git directory (i.e. $GIT_DIR is not set). | |
596 | This can also be controlled by the '--work-tree' command line | |
597 | option and the core.worktree configuration variable. | |
598 | ||
0454dd93 DR |
599 | 'GIT_CEILING_DIRECTORIES':: |
600 | This should be a colon-separated list of absolute paths. | |
601 | If set, it is a list of directories that git should not chdir | |
602 | up into while looking for a repository directory. | |
603 | It will not exclude the current working directory or | |
604 | a GIT_DIR set on the command line or in the environment. | |
605 | (Useful for excluding slow-loading network directories.) | |
606 | ||
cf87463e | 607 | 'GIT_DISCOVERY_ACROSS_FILESYSTEM':: |
e6405517 JH |
608 | When run in a directory that does not have ".git" repository |
609 | directory, git tries to find such a directory in the parent | |
610 | directories to find the top of the working tree, but by default it | |
611 | does not cross filesystem boundaries. This environment variable | |
cf87463e JH |
612 | can be set to true to tell git not to stop at filesystem |
613 | boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect | |
614 | an explicit repository directory set via 'GIT_DIR' or on the | |
615 | command line. | |
8030e442 | 616 | |
c1bdacf9 DG |
617 | git Commits |
618 | ~~~~~~~~~~~ | |
619 | 'GIT_AUTHOR_NAME':: | |
620 | 'GIT_AUTHOR_EMAIL':: | |
621 | 'GIT_AUTHOR_DATE':: | |
622 | 'GIT_COMMITTER_NAME':: | |
623 | 'GIT_COMMITTER_EMAIL':: | |
4e58bf97 | 624 | 'GIT_COMMITTER_DATE':: |
28a94f88 | 625 | 'EMAIL':: |
5162e697 | 626 | see linkgit:git-commit-tree[1] |
c1bdacf9 DG |
627 | |
628 | git Diffs | |
629 | ~~~~~~~~~ | |
d81ed1b5 | 630 | 'GIT_DIFF_OPTS':: |
fde97d8a SE |
631 | Only valid setting is "--unified=??" or "-u??" to set the |
632 | number of context lines shown when a unified diff is created. | |
633 | This takes precedence over any "-U" or "--unified" option | |
634 | value passed on the git diff command line. | |
635 | ||
d81ed1b5 | 636 | 'GIT_EXTERNAL_DIFF':: |
fde97d8a SE |
637 | When the environment variable 'GIT_EXTERNAL_DIFF' is set, the |
638 | program named by it is called, instead of the diff invocation | |
639 | described above. For a path that is added, removed, or modified, | |
640 | 'GIT_EXTERNAL_DIFF' is called with 7 parameters: | |
641 | ||
642 | path old-file old-hex old-mode new-file new-hex new-mode | |
643 | + | |
644 | where: | |
645 | ||
646 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the | |
647 | contents of <old|new>, | |
648 | <old|new>-hex:: are the 40-hexdigit SHA1 hashes, | |
649 | <old|new>-mode:: are the octal representation of the file modes. | |
fde97d8a SE |
650 | + |
651 | The file parameters can point at the user's working file | |
652 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` | |
653 | when a new file is added), or a temporary file (e.g. `old-file` in the | |
654 | index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the | |
655 | temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. | |
656 | + | |
657 | For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 | |
658 | parameter, <path>. | |
2cf565c5 | 659 | |
575ba9d6 ML |
660 | other |
661 | ~~~~~ | |
dbddb714 JN |
662 | 'GIT_MERGE_VERBOSITY':: |
663 | A number controlling the amount of output shown by | |
664 | the recursive merge strategy. Overrides merge.verbosity. | |
5162e697 | 665 | See linkgit:git-merge[1] |
dbddb714 | 666 | |
c27d205a | 667 | 'GIT_PAGER':: |
a7738c77 SG |
668 | This environment variable overrides `$PAGER`. If it is set |
669 | to an empty string or to the value "cat", git will not launch | |
ab54cd6c JN |
670 | a pager. See also the `core.pager` option in |
671 | linkgit:git-config[1]. | |
c27d205a | 672 | |
d5538b41 | 673 | 'GIT_SSH':: |
0b444cdb TR |
674 | If this environment variable is set then 'git fetch' |
675 | and 'git push' will use this command instead | |
2fd02c92 | 676 | of 'ssh' when they need to connect to a remote system. |
483bc4f0 | 677 | The '$GIT_SSH' command will be given exactly two arguments: |
d5538b41 SP |
678 | the 'username@host' (or just 'host') from the URL and the |
679 | shell command to execute on that remote system. | |
680 | + | |
681 | To pass options to the program that you want to list in GIT_SSH | |
682 | you will need to wrap the program and options into a shell script, | |
683 | then set GIT_SSH to refer to the shell script. | |
684 | + | |
685 | Usually it is easier to configure any desired options through your | |
686 | personal `.ssh/config` file. Please consult your ssh documentation | |
687 | for further details. | |
688 | ||
453842c9 KF |
689 | 'GIT_ASKPASS':: |
690 | If this environment variable is set, then git commands which need to | |
691 | acquire passwords or passphrases (e.g. for HTTP or IMAP authentication) | |
692 | will call this program with a suitable prompt as command line argument | |
693 | and read the password from its STDOUT. See also the 'core.askpass' | |
694 | option in linkgit:git-config[1]. | |
695 | ||
06f59e9f TT |
696 | 'GIT_FLUSH':: |
697 | If this environment variable is set to "1", then commands such | |
0b444cdb TR |
698 | as 'git blame' (in incremental mode), 'git rev-list', 'git log', |
699 | and 'git whatchanged' will force a flush of the output stream | |
06f59e9f TT |
700 | after each commit-oriented record have been flushed. If this |
701 | variable is set to "0", the output of these commands will be done | |
702 | using completely buffered I/O. If this environment variable is | |
703 | not set, git will choose buffered or record-oriented flushing | |
704 | based on whether stdout appears to be redirected to a file or not. | |
705 | ||
575ba9d6 | 706 | 'GIT_TRACE':: |
2886bdb1 CC |
707 | If this variable is set to "1", "2" or "true" (comparison |
708 | is case insensitive), git will print `trace:` messages on | |
575ba9d6 ML |
709 | stderr telling about alias expansion, built-in command |
710 | execution and external command execution. | |
2886bdb1 CC |
711 | If this variable is set to an integer value greater than 1 |
712 | and lower than 10 (strictly) then git will interpret this | |
713 | value as an open file descriptor and will try to write the | |
714 | trace messages into this file descriptor. | |
715 | Alternatively, if this variable is set to an absolute path | |
716 | (starting with a '/' character), git will interpret this | |
717 | as a file path and will try to write the trace messages | |
718 | into it. | |
575ba9d6 | 719 | |
8db9307c JH |
720 | Discussion[[Discussion]] |
721 | ------------------------ | |
40dac517 BF |
722 | |
723 | More detail on the following is available from the | |
724 | link:user-manual.html#git-concepts[git concepts chapter of the | |
6998e4db | 725 | user-manual] and linkgit:gitcore-tutorial[7]. |
40dac517 BF |
726 | |
727 | A git project normally consists of a working directory with a ".git" | |
728 | subdirectory at the top level. The .git directory contains, among other | |
729 | things, a compressed object database representing the complete history | |
730 | of the project, an "index" file which links that history to the current | |
731 | contents of the working tree, and named pointers into that history such | |
732 | as tags and branch heads. | |
733 | ||
734 | The object database contains objects of three main types: blobs, which | |
735 | hold file data; trees, which point to blobs and other trees to build up | |
02ff6250 | 736 | directory hierarchies; and commits, which each reference a single tree |
40dac517 BF |
737 | and some number of parent commits. |
738 | ||
739 | The commit, equivalent to what other systems call a "changeset" or | |
740 | "version", represents a step in the project's history, and each parent | |
741 | represents an immediately preceding step. Commits with more than one | |
742 | parent represent merges of independent lines of development. | |
743 | ||
744 | All objects are named by the SHA1 hash of their contents, normally | |
745 | written as a string of 40 hex digits. Such names are globally unique. | |
746 | The entire history leading up to a commit can be vouched for by signing | |
747 | just that commit. A fourth object type, the tag, is provided for this | |
748 | purpose. | |
749 | ||
750 | When first created, objects are stored in individual files, but for | |
751 | efficiency may later be compressed together into "pack files". | |
752 | ||
753 | Named pointers called refs mark interesting points in history. A ref | |
754 | may contain the SHA1 name of an object or the name of another ref. Refs | |
755 | with names beginning `ref/head/` contain the SHA1 name of the most | |
02ff6250 | 756 | recent commit (or "head") of a branch under development. SHA1 names of |
40dac517 BF |
757 | tags of interest are stored under `ref/tags/`. A special ref named |
758 | `HEAD` contains the name of the currently checked-out branch. | |
759 | ||
760 | The index file is initialized with a list of all paths and, for each | |
761 | path, a blob object and a set of attributes. The blob object represents | |
762 | the contents of the file as of the head of the current branch. The | |
763 | attributes (last modified time, size, etc.) are taken from the | |
764 | corresponding file in the working tree. Subsequent changes to the | |
765 | working tree can be found by comparing these attributes. The index may | |
766 | be updated with new content, and new commits may be created from the | |
767 | content stored in the index. | |
768 | ||
769 | The index is also capable of storing multiple entries (called "stages") | |
770 | for a given pathname. These stages are used to hold the various | |
771 | unmerged version of a file when a merge is in progress. | |
6c84e2e0 | 772 | |
cb22bc44 AE |
773 | Authors |
774 | ------- | |
48bb914e JK |
775 | Git was started by Linus Torvalds, and is currently maintained by Junio |
776 | C Hamano. Numerous contributions have come from the git mailing list | |
d8f708f8 JK |
777 | <git@vger.kernel.org>. For a more complete list of contributors, see |
778 | http://git-scm.com/about. If you have a clone of git.git itself, the | |
779 | output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you | |
780 | the authors for specific parts of the project. | |
2cf565c5 | 781 | |
c97ca277 JH |
782 | Reporting Bugs |
783 | -------------- | |
784 | ||
785 | Report bugs to the Git mailing list <git@vger.kernel.org> where the | |
786 | development and maintenance is primarily done. You do not have to be | |
787 | subscribed to the list to send a message there. | |
788 | ||
497c8331 CC |
789 | SEE ALSO |
790 | -------- | |
791 | linkgit:gittutorial[7], linkgit:gittutorial-2[7], | |
5cbef01a | 792 | link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7], |
497c8331 | 793 | linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], |
801a011d TR |
794 | linkgit:gitcli[7], link:user-manual.html[The Git User's Manual], |
795 | linkgit:gitworkflows[7] | |
497c8331 | 796 | |
2cf565c5 DG |
797 | GIT |
798 | --- | |
9e1f0a85 | 799 | Part of the linkgit:git[1] suite |