]>
Commit | Line | Data |
---|---|---|
7984eabe | 1 | git(7) |
2cf565c5 | 2 | ====== |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
6 | git - the stupid content tracker | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
8b70004b | 11 | [verse] |
6acbcb92 | 12 | 'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate] |
8b70004b | 13 | [--bare] [--git-dir=GIT_DIR] [--help] COMMAND [ARGS] |
2cf565c5 DG |
14 | |
15 | DESCRIPTION | |
16 | ----------- | |
23091e95 BF |
17 | Git is a fast, scalable, distributed revision control system with an |
18 | unusually rich command set that provides both high-level operations | |
19 | and full access to internals. | |
20 | ||
21 | See this link:tutorial.html[tutorial] to get started, then see | |
22 | link:everyday.html[Everyday Git] for a useful minimum set of commands, and | |
23 | "man git-commandname" for documentation of each command. CVS users may | |
24 | also want to read link:cvs-migration.html[CVS migration]. | |
cb22bc44 | 25 | |
4514ad4f PB |
26 | The COMMAND is either a name of a Git command (see below) or an alias |
27 | as defined in the configuration file (see gitlink:git-repo-config[1]). | |
28 | ||
cb22bc44 AE |
29 | OPTIONS |
30 | ------- | |
31 | --version:: | |
a87cd02c | 32 | Prints the git suite version that the 'git' program came from. |
cb22bc44 AE |
33 | |
34 | --help:: | |
a87cd02c FK |
35 | Prints the synopsis and a list of the most commonly used |
36 | commands. If a git command is named this option will bring up | |
37 | the man-page for that command. If the option '--all' or '-a' is | |
38 | given then all available commands are printed. | |
cb22bc44 AE |
39 | |
40 | --exec-path:: | |
a87cd02c | 41 | Path to wherever your core git programs are installed. |
cb22bc44 AE |
42 | This can also be controlled by setting the GIT_EXEC_PATH |
43 | environment variable. If no path is given 'git' will print | |
44 | the current setting and then exit. | |
45 | ||
6acbcb92 JS |
46 | -p|--paginate:: |
47 | Pipe all output into 'less' (or if set, $PAGER). | |
48 | ||
49 | --git-dir=<path>:: | |
50 | Set the path to the repository. This can also be controlled by | |
51 | setting the GIT_DIR environment variable. | |
52 | ||
53 | --bare:: | |
54 | Same as --git-dir=`pwd`. | |
9755afbd | 55 | |
23091e95 BF |
56 | FURTHER DOCUMENTATION |
57 | --------------------- | |
9755afbd | 58 | |
23091e95 BF |
59 | See the references above to get started using git. The following is |
60 | probably more detail than necessary for a first-time user. | |
8db9307c | 61 | |
23091e95 BF |
62 | The <<Discussion,Discussion>> section below and the |
63 | link:core-tutorial.html[Core tutorial] both provide introductions to the | |
64 | underlying git architecture. | |
e6fc2346 | 65 | |
23091e95 BF |
66 | See also the link:howto-index.html[howto] documents for some useful |
67 | examples. | |
9755afbd | 68 | |
23091e95 BF |
69 | GIT COMMANDS |
70 | ------------ | |
9755afbd | 71 | |
23091e95 BF |
72 | We divide git into high level ("porcelain") commands and low level |
73 | ("plumbing") commands. | |
8b15e2fb | 74 | |
23091e95 BF |
75 | High-level commands (porcelain) |
76 | ------------------------------- | |
77 | ||
78 | We separate the porcelain commands into the main commands and some | |
79 | ancillary user utilities. | |
80 | ||
81 | Main porcelain commands | |
82 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
905197de | 83 | |
a7154e91 | 84 | gitlink:git-add[1]:: |
2fa090b6 | 85 | Add paths to the index. |
905197de | 86 | |
8548ea8d PB |
87 | gitlink:git-am[1]:: |
88 | Apply patches from a mailbox, but cooler. | |
89 | ||
a7154e91 | 90 | gitlink:git-applymbox[1]:: |
2fa090b6 | 91 | Apply patches from a mailbox, original version by Linus. |
f85a4191 | 92 | |
e8daf78a FBH |
93 | gitlink:git-archive[1]:: |
94 | Creates an archive of files from a named tree. | |
95 | ||
a7154e91 | 96 | gitlink:git-bisect[1]:: |
2fa090b6 | 97 | Find the change that introduced a bug by binary search. |
f85a4191 | 98 | |
a7154e91 | 99 | gitlink:git-branch[1]:: |
905197de JH |
100 | Create and Show branches. |
101 | ||
a7154e91 | 102 | gitlink:git-checkout[1]:: |
452ce291 JH |
103 | Checkout and switch to a branch. |
104 | ||
a7154e91 | 105 | gitlink:git-cherry-pick[1]:: |
f85a4191 | 106 | Cherry-pick the effect of an existing commit. |
3f971fc4 | 107 | |
c16e30c0 JH |
108 | gitlink:git-clean[1]:: |
109 | Remove untracked files from the working tree. | |
110 | ||
a7154e91 | 111 | gitlink:git-clone[1]:: |
f85a4191 | 112 | Clones a repository into a new directory. |
3f971fc4 | 113 | |
a7154e91 | 114 | gitlink:git-commit[1]:: |
f85a4191 | 115 | Record changes to the repository. |
3f971fc4 | 116 | |
a7154e91 | 117 | gitlink:git-diff[1]:: |
2aba319a | 118 | Show changes between commits, commit and working tree, etc. |
35ef3a4c | 119 | |
a7154e91 | 120 | gitlink:git-fetch[1]:: |
62033318 JH |
121 | Download from a remote repository via various protocols. |
122 | ||
a7154e91 | 123 | gitlink:git-format-patch[1]:: |
2aba319a | 124 | Prepare patches for e-mail submission. |
35ef3a4c | 125 | |
a7154e91 | 126 | gitlink:git-grep[1]:: |
2fa090b6 | 127 | Print lines matching a pattern. |
2aba319a | 128 | |
ef118622 JF |
129 | gitlink:gitk[1]:: |
130 | The git repository browser. | |
131 | ||
a7154e91 | 132 | gitlink:git-log[1]:: |
f85a4191 | 133 | Shows commit logs. |
62033318 | 134 | |
a7154e91 | 135 | gitlink:git-ls-remote[1]:: |
f85a4191 | 136 | Shows references in a remote or local repository. |
ab9b3138 | 137 | |
a7154e91 | 138 | gitlink:git-merge[1]:: |
0f69be53 JH |
139 | Grand unified merge driver. |
140 | ||
8548ea8d PB |
141 | gitlink:git-mv[1]:: |
142 | Move or rename a file, a directory, or a symlink. | |
143 | ||
d28f7cb9 JH |
144 | gitlink:git-pack-refs[1]:: |
145 | Pack heads and tags for efficient repository access. | |
146 | ||
a7154e91 | 147 | gitlink:git-pull[1]:: |
ce4231ff | 148 | Fetch from and merge with a remote repository or a local branch. |
f85a4191 | 149 | |
a7154e91 | 150 | gitlink:git-push[1]:: |
ab9b3138 JH |
151 | Update remote refs along with associated objects. |
152 | ||
a7154e91 | 153 | gitlink:git-rebase[1]:: |
2fa090b6 | 154 | Rebase local commits to the updated upstream head. |
62033318 | 155 | |
a7154e91 | 156 | gitlink:git-repack[1]:: |
e31bb3bb JH |
157 | Pack unpacked objects in a repository. |
158 | ||
8389b52b JH |
159 | gitlink:git-rerere[1]:: |
160 | Reuse recorded resolution of conflicted merges. | |
161 | ||
a7154e91 | 162 | gitlink:git-reset[1]:: |
452ce291 JH |
163 | Reset current HEAD to the specified state. |
164 | ||
a7154e91 | 165 | gitlink:git-resolve[1]:: |
f85a4191 | 166 | Merge two commits. |
83db04ff | 167 | |
a7154e91 | 168 | gitlink:git-revert[1]:: |
f85a4191 JH |
169 | Revert an existing commit. |
170 | ||
c16e30c0 JH |
171 | gitlink:git-rm[1]:: |
172 | Remove files from the working tree and from the index. | |
173 | ||
a7154e91 | 174 | gitlink:git-shortlog[1]:: |
f85a4191 JH |
175 | Summarizes 'git log' output. |
176 | ||
55258b5c JL |
177 | gitlink:git-show[1]:: |
178 | Show one commit log and its diff. | |
179 | ||
a7154e91 | 180 | gitlink:git-show-branch[1]:: |
f85a4191 JH |
181 | Show branches and their commits. |
182 | ||
a7154e91 | 183 | gitlink:git-status[1]:: |
f85a4191 | 184 | Shows the working tree status. |
83db04ff | 185 | |
a7154e91 | 186 | gitlink:git-verify-tag[1]:: |
905197de JH |
187 | Check the GPG signature of tag. |
188 | ||
a7154e91 | 189 | gitlink:git-whatchanged[1]:: |
f85a4191 JH |
190 | Shows commit logs and differences they introduce. |
191 | ||
e31bb3bb | 192 | |
90933efb | 193 | Ancillary Commands |
23091e95 | 194 | ~~~~~~~~~~~~~~~~~~ |
2f2de9b4 JH |
195 | Manipulators: |
196 | ||
a7154e91 | 197 | gitlink:git-applypatch[1]:: |
f85a4191 | 198 | Apply one patch extracted from an e-mail. |
905197de | 199 | |
a7154e91 | 200 | gitlink:git-archimport[1]:: |
5077fa9c JH |
201 | Import an arch repository into git. |
202 | ||
a7154e91 | 203 | gitlink:git-convert-objects[1]:: |
2fa090b6 | 204 | Converts old-style git repository. |
2f2de9b4 | 205 | |
a7154e91 | 206 | gitlink:git-cvsimport[1]:: |
f85a4191 JH |
207 | Salvage your data out of another SCM people love to hate. |
208 | ||
76cead39 JH |
209 | gitlink:git-cvsexportcommit[1]:: |
210 | Export a single commit to a CVS checkout. | |
211 | ||
c16e30c0 JH |
212 | gitlink:git-cvsserver[1]:: |
213 | A CVS server emulator for git. | |
214 | ||
0086e2c8 | 215 | gitlink:git-lost-found[1]:: |
04e7ca1a JH |
216 | Recover lost refs that luckily have not yet been pruned. |
217 | ||
a7154e91 | 218 | gitlink:git-merge-one-file[1]:: |
2fa090b6 | 219 | The standard helper program to use with `git-merge-index`. |
204ee6a9 | 220 | |
a7154e91 | 221 | gitlink:git-prune[1]:: |
2fa090b6 | 222 | Prunes all unreachable objects from the object database. |
204ee6a9 | 223 | |
34925d35 JH |
224 | gitlink:git-quiltimport[1]:: |
225 | Applies a quilt patchset onto the current branch. | |
226 | ||
a7154e91 | 227 | gitlink:git-relink[1]:: |
f85a4191 JH |
228 | Hardlink common objects in local repositories. |
229 | ||
f5fffbd3 JH |
230 | gitlink:git-svn[1]:: |
231 | Bidirectional operation between a single Subversion branch and git. | |
232 | ||
8548ea8d PB |
233 | gitlink:git-svnimport[1]:: |
234 | Import a SVN repository into git. | |
235 | ||
a7154e91 | 236 | gitlink:git-sh-setup[1]:: |
f85a4191 JH |
237 | Common git shell script setup code. |
238 | ||
a60d2d8f | 239 | gitlink:git-symbolic-ref[1]:: |
2fa090b6 | 240 | Read and modify symbolic refs. |
a60d2d8f | 241 | |
a7154e91 | 242 | gitlink:git-tag[1]:: |
2fa090b6 | 243 | An example script to create a tag object signed with GPG. |
204ee6a9 | 244 | |
8548ea8d PB |
245 | gitlink:git-update-ref[1]:: |
246 | Update the object name stored in a ref safely. | |
247 | ||
204ee6a9 | 248 | |
90933efb | 249 | Interrogators: |
204ee6a9 | 250 | |
8f2b72a9 JF |
251 | gitlink:git-annotate[1]:: |
252 | Annotate file lines with commit info. | |
253 | ||
254 | gitlink:git-blame[1]:: | |
cee7f245 JH |
255 | Find out where each line in a file came from. |
256 | ||
8548ea8d PB |
257 | gitlink:git-check-ref-format[1]:: |
258 | Make sure ref name is well formed. | |
259 | ||
a7154e91 | 260 | gitlink:git-cherry[1]:: |
f85a4191 | 261 | Find commits not merged upstream. |
905197de | 262 | |
a7154e91 | 263 | gitlink:git-count-objects[1]:: |
905197de JH |
264 | Count unpacked number of objects and their disk consumption. |
265 | ||
a7154e91 | 266 | gitlink:git-daemon[1]:: |
72e9340c | 267 | A really simple server for git repositories. |
5077fa9c | 268 | |
c16e30c0 JH |
269 | gitlink:git-fmt-merge-msg[1]:: |
270 | Produce a merge commit message. | |
271 | ||
a7154e91 | 272 | gitlink:git-get-tar-commit-id[1]:: |
5077fa9c JH |
273 | Extract commit ID from an archive created using git-tar-tree. |
274 | ||
c16e30c0 JH |
275 | gitlink:git-imap-send[1]:: |
276 | Dump a mailbox from stdin into an imap folder. | |
277 | ||
f5fffbd3 JH |
278 | gitlink:git-instaweb[1]:: |
279 | Instantly browse your working repository in gitweb. | |
280 | ||
a7154e91 | 281 | gitlink:git-mailinfo[1]:: |
2fa090b6 JH |
282 | Extracts patch and authorship information from a single |
283 | e-mail message, optionally transliterating the commit | |
284 | message into utf-8. | |
f85a4191 | 285 | |
a7154e91 | 286 | gitlink:git-mailsplit[1]:: |
2fa090b6 JH |
287 | A stupid program to split UNIX mbox format mailbox into |
288 | individual pieces of e-mail. | |
f85a4191 | 289 | |
c16e30c0 JH |
290 | gitlink:git-merge-tree[1]:: |
291 | Show three-way merge without touching index. | |
292 | ||
a7154e91 | 293 | gitlink:git-patch-id[1]:: |
f85a4191 | 294 | Compute unique ID for a patch. |
204ee6a9 | 295 | |
a7154e91 | 296 | gitlink:git-parse-remote[1]:: |
2fa090b6 | 297 | Routines to help parsing `$GIT_DIR/remotes/` files. |
5077fa9c | 298 | |
a7154e91 | 299 | gitlink:git-request-pull[1]:: |
215a7ad1 | 300 | git-request-pull. |
5077fa9c | 301 | |
a7154e91 | 302 | gitlink:git-rev-parse[1]:: |
5077fa9c JH |
303 | Pick out and massage parameters. |
304 | ||
fd931411 RS |
305 | gitlink:git-runstatus[1]:: |
306 | A helper for git-status and git-commit. | |
307 | ||
a7154e91 | 308 | gitlink:git-send-email[1]:: |
83db04ff | 309 | Send patch e-mails out of "format-patch --mbox" output. |
204ee6a9 | 310 | |
c1fe2fe4 | 311 | gitlink:git-symbolic-ref[1]:: |
8548ea8d PB |
312 | Read and modify symbolic refs. |
313 | ||
a7154e91 | 314 | gitlink:git-stripspace[1]:: |
35ef3a4c | 315 | Filter out empty lines. |
7fc9d69f | 316 | |
7fc9d69f | 317 | |
b1f33d62 RR |
318 | Low-level commands (plumbing) |
319 | ----------------------------- | |
320 | ||
321 | Although git includes its | |
322 | own porcelain layer, its low-level commands are sufficient to support | |
323 | development of alternative porcelains. Developers of such porcelains | |
324 | might start by reading about gitlink:git-update-index[1] and | |
325 | gitlink:git-read-tree[1]. | |
326 | ||
327 | We divide the low-level commands into commands that manipulate objects (in | |
328 | the repository, index, and working tree), commands that interrogate and | |
329 | compare objects, and commands that move objects and references between | |
330 | repositories. | |
331 | ||
332 | Manipulation commands | |
333 | ~~~~~~~~~~~~~~~~~~~~~ | |
334 | gitlink:git-apply[1]:: | |
335 | Reads a "diff -up1" or git generated patch file and | |
336 | applies it to the working tree. | |
337 | ||
338 | gitlink:git-checkout-index[1]:: | |
339 | Copy files from the index to the working tree. | |
340 | ||
341 | gitlink:git-commit-tree[1]:: | |
342 | Creates a new commit object. | |
343 | ||
344 | gitlink:git-hash-object[1]:: | |
345 | Computes the object ID from a file. | |
346 | ||
347 | gitlink:git-index-pack[1]:: | |
348 | Build pack idx file for an existing packed archive. | |
349 | ||
350 | gitlink:git-init-db[1]:: | |
351 | Creates an empty git object database, or reinitialize an | |
352 | existing one. | |
353 | ||
354 | gitlink:git-merge-index[1]:: | |
355 | Runs a merge for files needing merging. | |
356 | ||
357 | gitlink:git-mktag[1]:: | |
358 | Creates a tag object. | |
359 | ||
360 | gitlink:git-mktree[1]:: | |
361 | Build a tree-object from ls-tree formatted text. | |
362 | ||
363 | gitlink:git-pack-objects[1]:: | |
364 | Creates a packed archive of objects. | |
365 | ||
366 | gitlink:git-prune-packed[1]:: | |
367 | Remove extra objects that are already in pack files. | |
368 | ||
369 | gitlink:git-read-tree[1]:: | |
370 | Reads tree information into the index. | |
371 | ||
372 | gitlink:git-repo-config[1]:: | |
373 | Get and set options in .git/config. | |
374 | ||
375 | gitlink:git-unpack-objects[1]:: | |
376 | Unpacks objects out of a packed archive. | |
377 | ||
378 | gitlink:git-update-index[1]:: | |
379 | Registers files in the working tree to the index. | |
380 | ||
381 | gitlink:git-write-tree[1]:: | |
382 | Creates a tree from the index. | |
383 | ||
384 | ||
385 | Interrogation commands | |
386 | ~~~~~~~~~~~~~~~~~~~~~~ | |
387 | ||
388 | gitlink:git-cat-file[1]:: | |
389 | Provide content or type/size information for repository objects. | |
390 | ||
391 | gitlink:git-describe[1]:: | |
392 | Show the most recent tag that is reachable from a commit. | |
393 | ||
394 | gitlink:git-diff-index[1]:: | |
395 | Compares content and mode of blobs between the index and repository. | |
396 | ||
397 | gitlink:git-diff-files[1]:: | |
398 | Compares files in the working tree and the index. | |
399 | ||
400 | gitlink:git-diff-stages[1]:: | |
401 | Compares two "merge stages" in the index. | |
402 | ||
403 | gitlink:git-diff-tree[1]:: | |
404 | Compares the content and mode of blobs found via two tree objects. | |
405 | ||
406 | gitlink:git-for-each-ref[1]:: | |
407 | Output information on each ref. | |
408 | ||
409 | gitlink:git-fsck-objects[1]:: | |
410 | Verifies the connectivity and validity of the objects in the database. | |
411 | ||
412 | gitlink:git-ls-files[1]:: | |
413 | Information about files in the index and the working tree. | |
414 | ||
415 | gitlink:git-ls-tree[1]:: | |
416 | Displays a tree object in human readable form. | |
417 | ||
418 | gitlink:git-merge-base[1]:: | |
419 | Finds as good common ancestors as possible for a merge. | |
420 | ||
421 | gitlink:git-name-rev[1]:: | |
422 | Find symbolic names for given revs. | |
423 | ||
424 | gitlink:git-pack-redundant[1]:: | |
425 | Find redundant pack files. | |
426 | ||
427 | gitlink:git-rev-list[1]:: | |
428 | Lists commit objects in reverse chronological order. | |
429 | ||
430 | gitlink:git-show-index[1]:: | |
431 | Displays contents of a pack idx file. | |
432 | ||
d28f7cb9 JH |
433 | gitlink:git-show-ref[1]:: |
434 | List references in a local repository. | |
435 | ||
b1f33d62 RR |
436 | gitlink:git-tar-tree[1]:: |
437 | Creates a tar archive of the files in the named tree object. | |
438 | ||
439 | gitlink:git-unpack-file[1]:: | |
440 | Creates a temporary file with a blob's contents. | |
441 | ||
442 | gitlink:git-var[1]:: | |
443 | Displays a git logical variable. | |
444 | ||
445 | gitlink:git-verify-pack[1]:: | |
446 | Validates packed git archive files. | |
447 | ||
448 | In general, the interrogate commands do not touch the files in | |
449 | the working tree. | |
450 | ||
451 | ||
452 | Synching repositories | |
453 | ~~~~~~~~~~~~~~~~~~~~~ | |
454 | ||
455 | gitlink:git-fetch-pack[1]:: | |
456 | Updates from a remote repository (engine for ssh and | |
457 | local transport). | |
458 | ||
459 | gitlink:git-http-fetch[1]:: | |
460 | Downloads a remote git repository via HTTP by walking | |
461 | commit chain. | |
462 | ||
463 | gitlink:git-local-fetch[1]:: | |
464 | Duplicates another git repository on a local system by | |
465 | walking commit chain. | |
466 | ||
467 | gitlink:git-peek-remote[1]:: | |
468 | Lists references on a remote repository using | |
469 | upload-pack protocol (engine for ssh and local | |
470 | transport). | |
471 | ||
472 | gitlink:git-receive-pack[1]:: | |
473 | Invoked by 'git-send-pack' to receive what is pushed to it. | |
474 | ||
475 | gitlink:git-send-pack[1]:: | |
476 | Pushes to a remote repository, intelligently. | |
477 | ||
478 | gitlink:git-http-push[1]:: | |
479 | Push missing objects using HTTP/DAV. | |
480 | ||
481 | gitlink:git-shell[1]:: | |
482 | Restricted shell for GIT-only SSH access. | |
483 | ||
484 | gitlink:git-ssh-fetch[1]:: | |
485 | Pulls from a remote repository over ssh connection by | |
486 | walking commit chain. | |
487 | ||
488 | gitlink:git-ssh-upload[1]:: | |
489 | Helper "server-side" program used by git-ssh-fetch. | |
490 | ||
491 | gitlink:git-update-server-info[1]:: | |
492 | Updates auxiliary information on a dumb server to help | |
493 | clients discover references and packs on it. | |
494 | ||
495 | gitlink:git-upload-archive[1]:: | |
496 | Invoked by 'git-archive' to send a generated archive. | |
497 | ||
498 | gitlink:git-upload-pack[1]:: | |
499 | Invoked by 'git-fetch-pack' to push | |
500 | what are asked for. | |
501 | ||
502 | ||
5773c9f2 JH |
503 | Configuration Mechanism |
504 | ----------------------- | |
505 | ||
2fa090b6 | 506 | Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file |
5773c9f2 | 507 | is used to hold per-repository configuration options. It is a |
addf88e4 | 508 | simple text file modeled after `.ini` format familiar to some |
5773c9f2 JH |
509 | people. Here is an example: |
510 | ||
511 | ------------ | |
512 | # | |
2fa090b6 | 513 | # A '#' or ';' character indicates a comment. |
5773c9f2 JH |
514 | # |
515 | ||
516 | ; core variables | |
517 | [core] | |
518 | ; Don't trust file modes | |
519 | filemode = false | |
520 | ||
521 | ; user identity | |
522 | [user] | |
523 | name = "Junio C Hamano" | |
524 | email = "junkio@twinsun.com" | |
525 | ||
526 | ------------ | |
527 | ||
528 | Various commands read from the configuration file and adjust | |
529 | their operation accordingly. | |
530 | ||
531 | ||
6c84e2e0 | 532 | Identifier Terminology |
2cf565c5 DG |
533 | ---------------------- |
534 | <object>:: | |
2fa090b6 | 535 | Indicates the object name for any type of object. |
2cf565c5 DG |
536 | |
537 | <blob>:: | |
2fa090b6 | 538 | Indicates a blob object name. |
2cf565c5 DG |
539 | |
540 | <tree>:: | |
2fa090b6 | 541 | Indicates a tree object name. |
2cf565c5 DG |
542 | |
543 | <commit>:: | |
2fa090b6 | 544 | Indicates a commit object name. |
2cf565c5 DG |
545 | |
546 | <tree-ish>:: | |
2fa090b6 | 547 | Indicates a tree, commit or tag object name. A |
6c84e2e0 DG |
548 | command that takes a <tree-ish> argument ultimately wants to |
549 | operate on a <tree> object but automatically dereferences | |
550 | <commit> and <tag> objects that point at a <tree>. | |
2cf565c5 DG |
551 | |
552 | <type>:: | |
553 | Indicates that an object type is required. | |
2fa090b6 | 554 | Currently one of: `blob`, `tree`, `commit`, or `tag`. |
2cf565c5 DG |
555 | |
556 | <file>:: | |
2fa090b6 JH |
557 | Indicates a filename - almost always relative to the |
558 | root of the tree structure `GIT_INDEX_FILE` describes. | |
2cf565c5 | 559 | |
c1bdacf9 DG |
560 | Symbolic Identifiers |
561 | -------------------- | |
90933efb | 562 | Any git command accepting any <object> can also use the following |
6c84e2e0 | 563 | symbolic notation: |
c1bdacf9 DG |
564 | |
565 | HEAD:: | |
2fa090b6 JH |
566 | indicates the head of the current branch (i.e. the |
567 | contents of `$GIT_DIR/HEAD`). | |
568 | ||
c1bdacf9 | 569 | <tag>:: |
2fa090b6 JH |
570 | a valid tag 'name' |
571 | (i.e. the contents of `$GIT_DIR/refs/tags/<tag>`). | |
572 | ||
c1bdacf9 | 573 | <head>:: |
2fa090b6 JH |
574 | a valid head 'name' |
575 | (i.e. the contents of `$GIT_DIR/refs/heads/<head>`). | |
576 | ||
d47107d8 JH |
577 | For a more complete list of ways to spell object names, see |
578 | "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. | |
579 | ||
c1bdacf9 DG |
580 | |
581 | File/Directory Structure | |
582 | ------------------------ | |
c1bdacf9 | 583 | |
a1d4aa74 | 584 | Please see link:repository-layout.html[repository layout] document. |
c1bdacf9 | 585 | |
6250ad1e JL |
586 | Read link:hooks.html[hooks] for more details about each hook. |
587 | ||
c1bdacf9 | 588 | Higher level SCMs may provide and manage additional information in the |
2fa090b6 | 589 | `$GIT_DIR`. |
c1bdacf9 | 590 | |
a1d4aa74 | 591 | |
2cf565c5 DG |
592 | Terminology |
593 | ----------- | |
1bff6490 | 594 | Please see link:glossary.html[glossary] document. |
2cf565c5 DG |
595 | |
596 | ||
597 | Environment Variables | |
598 | --------------------- | |
599 | Various git commands use the following environment variables: | |
600 | ||
c1bdacf9 DG |
601 | The git Repository |
602 | ~~~~~~~~~~~~~~~~~~ | |
603 | These environment variables apply to 'all' core git commands. Nb: it | |
604 | is worth noting that they may be used/overridden by SCMS sitting above | |
2fa090b6 | 605 | git so take care if using Cogito etc. |
c1bdacf9 DG |
606 | |
607 | 'GIT_INDEX_FILE':: | |
608 | This environment allows the specification of an alternate | |
5f3aa197 LS |
609 | index file. If not specified, the default of `$GIT_DIR/index` |
610 | is used. | |
c1bdacf9 DG |
611 | |
612 | 'GIT_OBJECT_DIRECTORY':: | |
613 | If the object storage directory is specified via this | |
614 | environment variable then the sha1 directories are created | |
615 | underneath - otherwise the default `$GIT_DIR/objects` | |
616 | directory is used. | |
617 | ||
618 | 'GIT_ALTERNATE_OBJECT_DIRECTORIES':: | |
619 | Due to the immutable nature of git objects, old objects can be | |
620 | archived into shared, read-only directories. This variable | |
90933efb | 621 | specifies a ":" separated list of git object directories which |
c1bdacf9 DG |
622 | can be used to search for git objects. New objects will not be |
623 | written to these directories. | |
624 | ||
625 | 'GIT_DIR':: | |
2fa090b6 JH |
626 | If the 'GIT_DIR' environment variable is set then it |
627 | specifies a path to use instead of the default `.git` | |
628 | for the base of the repository. | |
c1bdacf9 DG |
629 | |
630 | git Commits | |
631 | ~~~~~~~~~~~ | |
632 | 'GIT_AUTHOR_NAME':: | |
633 | 'GIT_AUTHOR_EMAIL':: | |
634 | 'GIT_AUTHOR_DATE':: | |
635 | 'GIT_COMMITTER_NAME':: | |
636 | 'GIT_COMMITTER_EMAIL':: | |
a7154e91 | 637 | see gitlink:git-commit-tree[1] |
c1bdacf9 DG |
638 | |
639 | git Diffs | |
640 | ~~~~~~~~~ | |
d81ed1b5 | 641 | 'GIT_DIFF_OPTS':: |
fde97d8a SE |
642 | Only valid setting is "--unified=??" or "-u??" to set the |
643 | number of context lines shown when a unified diff is created. | |
644 | This takes precedence over any "-U" or "--unified" option | |
645 | value passed on the git diff command line. | |
646 | ||
d81ed1b5 | 647 | 'GIT_EXTERNAL_DIFF':: |
fde97d8a SE |
648 | When the environment variable 'GIT_EXTERNAL_DIFF' is set, the |
649 | program named by it is called, instead of the diff invocation | |
650 | described above. For a path that is added, removed, or modified, | |
651 | 'GIT_EXTERNAL_DIFF' is called with 7 parameters: | |
652 | ||
653 | path old-file old-hex old-mode new-file new-hex new-mode | |
654 | + | |
655 | where: | |
656 | ||
657 | <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the | |
658 | contents of <old|new>, | |
659 | <old|new>-hex:: are the 40-hexdigit SHA1 hashes, | |
660 | <old|new>-mode:: are the octal representation of the file modes. | |
661 | ||
662 | + | |
663 | The file parameters can point at the user's working file | |
664 | (e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file` | |
665 | when a new file is added), or a temporary file (e.g. `old-file` in the | |
666 | index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the | |
667 | temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits. | |
668 | + | |
669 | For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1 | |
670 | parameter, <path>. | |
2cf565c5 | 671 | |
575ba9d6 ML |
672 | other |
673 | ~~~~~ | |
c27d205a ML |
674 | 'GIT_PAGER':: |
675 | This environment variable overrides `$PAGER`. | |
676 | ||
575ba9d6 | 677 | 'GIT_TRACE':: |
2886bdb1 CC |
678 | If this variable is set to "1", "2" or "true" (comparison |
679 | is case insensitive), git will print `trace:` messages on | |
575ba9d6 ML |
680 | stderr telling about alias expansion, built-in command |
681 | execution and external command execution. | |
2886bdb1 CC |
682 | If this variable is set to an integer value greater than 1 |
683 | and lower than 10 (strictly) then git will interpret this | |
684 | value as an open file descriptor and will try to write the | |
685 | trace messages into this file descriptor. | |
686 | Alternatively, if this variable is set to an absolute path | |
687 | (starting with a '/' character), git will interpret this | |
688 | as a file path and will try to write the trace messages | |
689 | into it. | |
575ba9d6 | 690 | |
8db9307c JH |
691 | Discussion[[Discussion]] |
692 | ------------------------ | |
941c9449 | 693 | include::README[] |
6c84e2e0 | 694 | |
cb22bc44 AE |
695 | Authors |
696 | ------- | |
9755afbd JH |
697 | * git's founding father is Linus Torvalds <torvalds@osdl.org>. |
698 | * The current git nurse is Junio C Hamano <junkio@cox.net>. | |
699 | * The git potty was written by Andres Ericsson <ae@op5.se>. | |
700 | * General upbringing is handled by the git-list <git@vger.kernel.org>. | |
2cf565c5 DG |
701 | |
702 | Documentation | |
703 | -------------- | |
9755afbd JH |
704 | The documentation for git suite was started by David Greaves |
705 | <david@dgreaves.com>, and later enhanced greatly by the | |
706 | contributors on the git-list <git@vger.kernel.org>. | |
2cf565c5 DG |
707 | |
708 | GIT | |
709 | --- | |
a7154e91 | 710 | Part of the gitlink:git[7] suite |
2cf565c5 | 711 |