OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git(1)">\r
5 <articleinfo>\r
6     <title>git(1)</title>\r
7         <indexterm>\r
8                 <primary>git(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git - the stupid content tracker</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git</emphasis> [--version] [--exec-path[=GIT_EXEC_PATH]]\r
19     [-p|--paginate|--no-pager]\r
20     [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]\r
21     [--help] COMMAND [ARGS]</literallayout>\r
22 </blockquote>\r
23 </simplesect>\r
24 <simplesect id="_description">\r
25 <title>DESCRIPTION</title>\r
26 <simpara>Git is a fast, scalable, distributed revision control system with an\r
27 unusually rich command set that provides both high-level operations\r
28 and full access to internals.</simpara>\r
29 <simpara>See <xref linkend="gittutorial(7)"/> to get started, then see\r
30 <ulink url="everyday.html">Everyday Git</ulink> for a useful minimum set of commands, and\r
31 "man git-commandname" for documentation of each command.  CVS users may\r
32 also want to read <xref linkend="gitcvs-migration(7)"/>.  See\r
33 the <ulink url="user-manual.html">Git User&#8217;s Manual</ulink> for a more in-depth\r
34 introduction.</simpara>\r
35 <simpara>The COMMAND is either a name of a Git command (see below) or an alias\r
36 as defined in the configuration file (see <xref linkend="git-config(1)"/>).</simpara>\r
37 <simpara>Formatted and hyperlinked version of the latest git\r
38 documentation can be viewed at\r
39 <literal>http://www.kernel.org/pub/software/scm/git/docs/</literal>.</simpara>\r
40 </simplesect>\r
41 <simplesect id="_options">\r
42 <title>OPTIONS</title>\r
43 <variablelist>\r
44 <varlistentry>\r
45 <term>\r
46 --version\r
47 </term>\r
48 <listitem>\r
49 <simpara>\r
50         Prints the git suite version that the <emphasis>git</emphasis> program came from.\r
51 </simpara>\r
52 </listitem>\r
53 </varlistentry>\r
54 <varlistentry>\r
55 <term>\r
56 --help\r
57 </term>\r
58 <listitem>\r
59 <simpara>\r
60         Prints the synopsis and a list of the most commonly used\r
61         commands. If the option <emphasis>--all</emphasis> or <emphasis>-a</emphasis> is given then all\r
62         available commands are printed. If a git command is named this\r
63         option will bring up the manual page for that command.\r
64 </simpara>\r
65 <simpara>Other options are available to control how the manual page is\r
66 displayed. See <xref linkend="git-help(1)"/> for more information,\r
67 because <literal>git --help &#8230;</literal> is converted internally into <literal>git\r
68 help &#8230;</literal>.</simpara>\r
69 </listitem>\r
70 </varlistentry>\r
71 <varlistentry>\r
72 <term>\r
73 --exec-path\r
74 </term>\r
75 <listitem>\r
76 <simpara>\r
77         Path to wherever your core git programs are installed.\r
78         This can also be controlled by setting the GIT_EXEC_PATH\r
79         environment variable. If no path is given, <emphasis>git</emphasis> will print\r
80         the current setting and then exit.\r
81 </simpara>\r
82 </listitem>\r
83 </varlistentry>\r
84 <varlistentry>\r
85 <term>\r
86 -p\r
87 </term>\r
88 <term>\r
89 --paginate\r
90 </term>\r
91 <listitem>\r
92 <simpara>\r
93         Pipe all output into <emphasis>less</emphasis> (or if set, $PAGER).\r
94 </simpara>\r
95 </listitem>\r
96 </varlistentry>\r
97 <varlistentry>\r
98 <term>\r
99 --no-pager\r
100 </term>\r
101 <listitem>\r
102 <simpara>\r
103         Do not pipe git output into a pager.\r
104 </simpara>\r
105 </listitem>\r
106 </varlistentry>\r
107 <varlistentry>\r
108 <term>\r
109 --git-dir=&lt;path&gt;\r
110 </term>\r
111 <listitem>\r
112 <simpara>\r
113         Set the path to the repository. This can also be controlled by\r
114         setting the GIT_DIR environment variable. It can be an absolute\r
115         path or relative path to current working directory.\r
116 </simpara>\r
117 </listitem>\r
118 </varlistentry>\r
119 <varlistentry>\r
120 <term>\r
121 --work-tree=&lt;path&gt;\r
122 </term>\r
123 <listitem>\r
124 <simpara>\r
125         Set the path to the working tree.  The value will not be\r
126         used in combination with repositories found automatically in\r
127         a .git directory (i.e. $GIT_DIR is not set).\r
128         This can also be controlled by setting the GIT_WORK_TREE\r
129         environment variable and the core.worktree configuration\r
130         variable. It can be an absolute path or relative path to\r
131         the directory specified by --git-dir or GIT_DIR.\r
132         Note: If --git-dir or GIT_DIR are specified but none of\r
133         --work-tree, GIT_WORK_TREE and core.worktree is specified,\r
134         the current working directory is regarded as the top directory\r
135         of your working tree.\r
136 </simpara>\r
137 </listitem>\r
138 </varlistentry>\r
139 <varlistentry>\r
140 <term>\r
141 --bare\r
142 </term>\r
143 <listitem>\r
144 <simpara>\r
145         Treat the repository as a bare repository.  If GIT_DIR\r
146         environment is not set, it is set to the current working\r
147         directory.\r
148 </simpara>\r
149 </listitem>\r
150 </varlistentry>\r
151 </variablelist>\r
152 </simplesect>\r
153 <simplesect id="_further_documentation">\r
154 <title>FURTHER DOCUMENTATION</title>\r
155 <simpara>See the references above to get started using git.  The following is\r
156 probably more detail than necessary for a first-time user.</simpara>\r
157 <simpara>The <ulink url="user-manual.html#git-concepts">git concepts chapter of the\r
158 user-manual</ulink> and <xref linkend="gitcore-tutorial(7)"/> both provide\r
159 introductions to the underlying git architecture.</simpara>\r
160 <simpara>See also the <ulink url="howto-index.html">howto</ulink> documents for some useful\r
161 examples.</simpara>\r
162 <simpara>The internals are documented in the\r
163 <ulink url="technical/api-index.html">GIT API documentation</ulink>.</simpara>\r
164 </simplesect>\r
165 <simplesect id="_git_commands">\r
166 <title>GIT COMMANDS</title>\r
167 <simpara>We divide git into high level ("porcelain") commands and low level\r
168 ("plumbing") commands.</simpara>\r
169 </simplesect>\r
170 <simplesect id="_high_level_commands_porcelain">\r
171 <title>High-level commands (porcelain)</title>\r
172 <simpara>We separate the porcelain commands into the main commands and some\r
173 ancillary user utilities.</simpara>\r
174 <simplesect id="_main_porcelain_commands">\r
175 <title>Main porcelain commands</title>\r
176 <variablelist>\r
177 <varlistentry>\r
178 <term>\r
179 <xref linkend="git-add(1)"/>\r
180 </term>\r
181 <listitem>\r
182 <simpara>\r
183         Add file contents to the index.\r
184 </simpara>\r
185 </listitem>\r
186 </varlistentry>\r
187 <varlistentry>\r
188 <term>\r
189 <xref linkend="git-am(1)"/>\r
190 </term>\r
191 <listitem>\r
192 <simpara>\r
193         Apply a series of patches from a mailbox.\r
194 </simpara>\r
195 </listitem>\r
196 </varlistentry>\r
197 <varlistentry>\r
198 <term>\r
199 <xref linkend="git-archive(1)"/>\r
200 </term>\r
201 <listitem>\r
202 <simpara>\r
203         Create an archive of files from a named tree.\r
204 </simpara>\r
205 </listitem>\r
206 </varlistentry>\r
207 <varlistentry>\r
208 <term>\r
209 <xref linkend="git-bisect(1)"/>\r
210 </term>\r
211 <listitem>\r
212 <simpara>\r
213         Find the change that introduced a bug by binary search.\r
214 </simpara>\r
215 </listitem>\r
216 </varlistentry>\r
217 <varlistentry>\r
218 <term>\r
219 <xref linkend="git-branch(1)"/>\r
220 </term>\r
221 <listitem>\r
222 <simpara>\r
223         List, create, or delete branches.\r
224 </simpara>\r
225 </listitem>\r
226 </varlistentry>\r
227 <varlistentry>\r
228 <term>\r
229 <xref linkend="git-bundle(1)"/>\r
230 </term>\r
231 <listitem>\r
232 <simpara>\r
233         Move objects and refs by archive.\r
234 </simpara>\r
235 </listitem>\r
236 </varlistentry>\r
237 <varlistentry>\r
238 <term>\r
239 <xref linkend="git-checkout(1)"/>\r
240 </term>\r
241 <listitem>\r
242 <simpara>\r
243         Checkout a branch or paths to the working tree.\r
244 </simpara>\r
245 </listitem>\r
246 </varlistentry>\r
247 <varlistentry>\r
248 <term>\r
249 <xref linkend="git-cherry-pick(1)"/>\r
250 </term>\r
251 <listitem>\r
252 <simpara>\r
253         Apply the change introduced by an existing commit.\r
254 </simpara>\r
255 </listitem>\r
256 </varlistentry>\r
257 <varlistentry>\r
258 <term>\r
259 <xref linkend="git-citool(1)"/>\r
260 </term>\r
261 <listitem>\r
262 <simpara>\r
263         Graphical alternative to git-commit.\r
264 </simpara>\r
265 </listitem>\r
266 </varlistentry>\r
267 <varlistentry>\r
268 <term>\r
269 <xref linkend="git-clean(1)"/>\r
270 </term>\r
271 <listitem>\r
272 <simpara>\r
273         Remove untracked files from the working tree.\r
274 </simpara>\r
275 </listitem>\r
276 </varlistentry>\r
277 <varlistentry>\r
278 <term>\r
279 <xref linkend="git-clone(1)"/>\r
280 </term>\r
281 <listitem>\r
282 <simpara>\r
283         Clone a repository into a new directory.\r
284 </simpara>\r
285 </listitem>\r
286 </varlistentry>\r
287 <varlistentry>\r
288 <term>\r
289 <xref linkend="git-commit(1)"/>\r
290 </term>\r
291 <listitem>\r
292 <simpara>\r
293         Record changes to the repository.\r
294 </simpara>\r
295 </listitem>\r
296 </varlistentry>\r
297 <varlistentry>\r
298 <term>\r
299 <xref linkend="git-describe(1)"/>\r
300 </term>\r
301 <listitem>\r
302 <simpara>\r
303         Show the most recent tag that is reachable from a commit.\r
304 </simpara>\r
305 </listitem>\r
306 </varlistentry>\r
307 <varlistentry>\r
308 <term>\r
309 <xref linkend="git-diff(1)"/>\r
310 </term>\r
311 <listitem>\r
312 <simpara>\r
313         Show changes between commits, commit and working tree, etc.\r
314 </simpara>\r
315 </listitem>\r
316 </varlistentry>\r
317 <varlistentry>\r
318 <term>\r
319 <xref linkend="git-fetch(1)"/>\r
320 </term>\r
321 <listitem>\r
322 <simpara>\r
323         Download objects and refs from another repository.\r
324 </simpara>\r
325 </listitem>\r
326 </varlistentry>\r
327 <varlistentry>\r
328 <term>\r
329 <xref linkend="git-format-patch(1)"/>\r
330 </term>\r
331 <listitem>\r
332 <simpara>\r
333         Prepare patches for e-mail submission.\r
334 </simpara>\r
335 </listitem>\r
336 </varlistentry>\r
337 <varlistentry>\r
338 <term>\r
339 <xref linkend="git-gc(1)"/>\r
340 </term>\r
341 <listitem>\r
342 <simpara>\r
343         Cleanup unnecessary files and optimize the local repository.\r
344 </simpara>\r
345 </listitem>\r
346 </varlistentry>\r
347 <varlistentry>\r
348 <term>\r
349 <xref linkend="git-grep(1)"/>\r
350 </term>\r
351 <listitem>\r
352 <simpara>\r
353         Print lines matching a pattern.\r
354 </simpara>\r
355 </listitem>\r
356 </varlistentry>\r
357 <varlistentry>\r
358 <term>\r
359 <xref linkend="git-gui(1)"/>\r
360 </term>\r
361 <listitem>\r
362 <simpara>\r
363         A portable graphical interface to Git.\r
364 </simpara>\r
365 </listitem>\r
366 </varlistentry>\r
367 <varlistentry>\r
368 <term>\r
369 <xref linkend="git-init(1)"/>\r
370 </term>\r
371 <listitem>\r
372 <simpara>\r
373         Create an empty git repository or reinitialize an existing one.\r
374 </simpara>\r
375 </listitem>\r
376 </varlistentry>\r
377 <varlistentry>\r
378 <term>\r
379 <xref linkend="git-log(1)"/>\r
380 </term>\r
381 <listitem>\r
382 <simpara>\r
383         Show commit logs.\r
384 </simpara>\r
385 </listitem>\r
386 </varlistentry>\r
387 <varlistentry>\r
388 <term>\r
389 <xref linkend="git-merge(1)"/>\r
390 </term>\r
391 <listitem>\r
392 <simpara>\r
393         Join two or more development histories together.\r
394 </simpara>\r
395 </listitem>\r
396 </varlistentry>\r
397 <varlistentry>\r
398 <term>\r
399 <xref linkend="git-mv(1)"/>\r
400 </term>\r
401 <listitem>\r
402 <simpara>\r
403         Move or rename a file, a directory, or a symlink.\r
404 </simpara>\r
405 </listitem>\r
406 </varlistentry>\r
407 <varlistentry>\r
408 <term>\r
409 <xref linkend="git-notes(1)"/>\r
410 </term>\r
411 <listitem>\r
412 <simpara>\r
413         Add/inspect commit notes.\r
414 </simpara>\r
415 </listitem>\r
416 </varlistentry>\r
417 <varlistentry>\r
418 <term>\r
419 <xref linkend="git-pull(1)"/>\r
420 </term>\r
421 <listitem>\r
422 <simpara>\r
423         Fetch from and merge with another repository or a local branch.\r
424 </simpara>\r
425 </listitem>\r
426 </varlistentry>\r
427 <varlistentry>\r
428 <term>\r
429 <xref linkend="git-push(1)"/>\r
430 </term>\r
431 <listitem>\r
432 <simpara>\r
433         Update remote refs along with associated objects.\r
434 </simpara>\r
435 </listitem>\r
436 </varlistentry>\r
437 <varlistentry>\r
438 <term>\r
439 <xref linkend="git-rebase(1)"/>\r
440 </term>\r
441 <listitem>\r
442 <simpara>\r
443         Forward-port local commits to the updated upstream head.\r
444 </simpara>\r
445 </listitem>\r
446 </varlistentry>\r
447 <varlistentry>\r
448 <term>\r
449 <xref linkend="git-reset(1)"/>\r
450 </term>\r
451 <listitem>\r
452 <simpara>\r
453         Reset current HEAD to the specified state.\r
454 </simpara>\r
455 </listitem>\r
456 </varlistentry>\r
457 <varlistentry>\r
458 <term>\r
459 <xref linkend="git-revert(1)"/>\r
460 </term>\r
461 <listitem>\r
462 <simpara>\r
463         Revert an existing commit.\r
464 </simpara>\r
465 </listitem>\r
466 </varlistentry>\r
467 <varlistentry>\r
468 <term>\r
469 <xref linkend="git-rm(1)"/>\r
470 </term>\r
471 <listitem>\r
472 <simpara>\r
473         Remove files from the working tree and from the index.\r
474 </simpara>\r
475 </listitem>\r
476 </varlistentry>\r
477 <varlistentry>\r
478 <term>\r
479 <xref linkend="git-shortlog(1)"/>\r
480 </term>\r
481 <listitem>\r
482 <simpara>\r
483         Summarize <emphasis>git-log</emphasis> output.\r
484 </simpara>\r
485 </listitem>\r
486 </varlistentry>\r
487 <varlistentry>\r
488 <term>\r
489 <xref linkend="git-show(1)"/>\r
490 </term>\r
491 <listitem>\r
492 <simpara>\r
493         Show various types of objects.\r
494 </simpara>\r
495 </listitem>\r
496 </varlistentry>\r
497 <varlistentry>\r
498 <term>\r
499 <xref linkend="git-stash(1)"/>\r
500 </term>\r
501 <listitem>\r
502 <simpara>\r
503         Stash the changes in a dirty working directory away.\r
504 </simpara>\r
505 </listitem>\r
506 </varlistentry>\r
507 <varlistentry>\r
508 <term>\r
509 <xref linkend="git-status(1)"/>\r
510 </term>\r
511 <listitem>\r
512 <simpara>\r
513         Show the working tree status.\r
514 </simpara>\r
515 </listitem>\r
516 </varlistentry>\r
517 <varlistentry>\r
518 <term>\r
519 <xref linkend="git-submodule(1)"/>\r
520 </term>\r
521 <listitem>\r
522 <simpara>\r
523         Initialize, update or inspect submodules.\r
524 </simpara>\r
525 </listitem>\r
526 </varlistentry>\r
527 <varlistentry>\r
528 <term>\r
529 <xref linkend="git-tag(1)"/>\r
530 </term>\r
531 <listitem>\r
532 <simpara>\r
533         Create, list, delete or verify a tag object signed with GPG.\r
534 </simpara>\r
535 </listitem>\r
536 </varlistentry>\r
537 <varlistentry>\r
538 <term>\r
539 <xref linkend="gitk(1)"/>\r
540 </term>\r
541 <listitem>\r
542 <simpara>\r
543         The git repository browser.\r
544 </simpara>\r
545 </listitem>\r
546 </varlistentry>\r
547 </variablelist>\r
548 </simplesect>\r
549 <simplesect id="_ancillary_commands">\r
550 <title>Ancillary Commands</title>\r
551 <simpara>Manipulators:</simpara>\r
552 <variablelist>\r
553 <varlistentry>\r
554 <term>\r
555 <xref linkend="git-config(1)"/>\r
556 </term>\r
557 <listitem>\r
558 <simpara>\r
559         Get and set repository or global options.\r
560 </simpara>\r
561 </listitem>\r
562 </varlistentry>\r
563 <varlistentry>\r
564 <term>\r
565 <xref linkend="git-fast-export(1)"/>\r
566 </term>\r
567 <listitem>\r
568 <simpara>\r
569         Git data exporter.\r
570 </simpara>\r
571 </listitem>\r
572 </varlistentry>\r
573 <varlistentry>\r
574 <term>\r
575 <xref linkend="git-fast-import(1)"/>\r
576 </term>\r
577 <listitem>\r
578 <simpara>\r
579         Backend for fast Git data importers.\r
580 </simpara>\r
581 </listitem>\r
582 </varlistentry>\r
583 <varlistentry>\r
584 <term>\r
585 <xref linkend="git-filter-branch(1)"/>\r
586 </term>\r
587 <listitem>\r
588 <simpara>\r
589         Rewrite branches.\r
590 </simpara>\r
591 </listitem>\r
592 </varlistentry>\r
593 <varlistentry>\r
594 <term>\r
595 <xref linkend="git-lost-found(1)"/>\r
596 </term>\r
597 <listitem>\r
598 <simpara>\r
599         (deprecated) Recover lost refs that luckily have not yet been pruned.\r
600 </simpara>\r
601 </listitem>\r
602 </varlistentry>\r
603 <varlistentry>\r
604 <term>\r
605 <xref linkend="git-mergetool(1)"/>\r
606 </term>\r
607 <listitem>\r
608 <simpara>\r
609         Run merge conflict resolution tools to resolve merge conflicts.\r
610 </simpara>\r
611 </listitem>\r
612 </varlistentry>\r
613 <varlistentry>\r
614 <term>\r
615 <xref linkend="git-pack-refs(1)"/>\r
616 </term>\r
617 <listitem>\r
618 <simpara>\r
619         Pack heads and tags for efficient repository access.\r
620 </simpara>\r
621 </listitem>\r
622 </varlistentry>\r
623 <varlistentry>\r
624 <term>\r
625 <xref linkend="git-prune(1)"/>\r
626 </term>\r
627 <listitem>\r
628 <simpara>\r
629         Prune all unreachable objects from the object database.\r
630 </simpara>\r
631 </listitem>\r
632 </varlistentry>\r
633 <varlistentry>\r
634 <term>\r
635 <xref linkend="git-reflog(1)"/>\r
636 </term>\r
637 <listitem>\r
638 <simpara>\r
639         Manage reflog information.\r
640 </simpara>\r
641 </listitem>\r
642 </varlistentry>\r
643 <varlistentry>\r
644 <term>\r
645 <xref linkend="git-relink(1)"/>\r
646 </term>\r
647 <listitem>\r
648 <simpara>\r
649         Hardlink common objects in local repositories.\r
650 </simpara>\r
651 </listitem>\r
652 </varlistentry>\r
653 <varlistentry>\r
654 <term>\r
655 <xref linkend="git-remote(1)"/>\r
656 </term>\r
657 <listitem>\r
658 <simpara>\r
659         manage set of tracked repositories.\r
660 </simpara>\r
661 </listitem>\r
662 </varlistentry>\r
663 <varlistentry>\r
664 <term>\r
665 <xref linkend="git-repack(1)"/>\r
666 </term>\r
667 <listitem>\r
668 <simpara>\r
669         Pack unpacked objects in a repository.\r
670 </simpara>\r
671 </listitem>\r
672 </varlistentry>\r
673 <varlistentry>\r
674 <term>\r
675 <xref linkend="git-repo-config(1)"/>\r
676 </term>\r
677 <listitem>\r
678 <simpara>\r
679         (deprecated) Get and set repository or global options.\r
680 </simpara>\r
681 </listitem>\r
682 </varlistentry>\r
683 </variablelist>\r
684 <simpara>Interrogators:</simpara>\r
685 <variablelist>\r
686 <varlistentry>\r
687 <term>\r
688 <xref linkend="git-annotate(1)"/>\r
689 </term>\r
690 <listitem>\r
691 <simpara>\r
692         Annotate file lines with commit info.\r
693 </simpara>\r
694 </listitem>\r
695 </varlistentry>\r
696 <varlistentry>\r
697 <term>\r
698 <xref linkend="git-blame(1)"/>\r
699 </term>\r
700 <listitem>\r
701 <simpara>\r
702         Show what revision and author last modified each line of a file.\r
703 </simpara>\r
704 </listitem>\r
705 </varlistentry>\r
706 <varlistentry>\r
707 <term>\r
708 <xref linkend="git-cherry(1)"/>\r
709 </term>\r
710 <listitem>\r
711 <simpara>\r
712         Find commits not merged upstream.\r
713 </simpara>\r
714 </listitem>\r
715 </varlistentry>\r
716 <varlistentry>\r
717 <term>\r
718 <xref linkend="git-count-objects(1)"/>\r
719 </term>\r
720 <listitem>\r
721 <simpara>\r
722         Count unpacked number of objects and their disk consumption.\r
723 </simpara>\r
724 </listitem>\r
725 </varlistentry>\r
726 <varlistentry>\r
727 <term>\r
728 <xref linkend="git-fsck(1)"/>\r
729 </term>\r
730 <listitem>\r
731 <simpara>\r
732         Verifies the connectivity and validity of the objects in the database.\r
733 </simpara>\r
734 </listitem>\r
735 </varlistentry>\r
736 <varlistentry>\r
737 <term>\r
738 <xref linkend="git-get-tar-commit-id(1)"/>\r
739 </term>\r
740 <listitem>\r
741 <simpara>\r
742         Extract commit ID from an archive created using git-archive.\r
743 </simpara>\r
744 </listitem>\r
745 </varlistentry>\r
746 <varlistentry>\r
747 <term>\r
748 <xref linkend="git-help(1)"/>\r
749 </term>\r
750 <listitem>\r
751 <simpara>\r
752         display help information about git.\r
753 </simpara>\r
754 </listitem>\r
755 </varlistentry>\r
756 <varlistentry>\r
757 <term>\r
758 <xref linkend="git-instaweb(1)"/>\r
759 </term>\r
760 <listitem>\r
761 <simpara>\r
762         Instantly browse your working repository in gitweb.\r
763 </simpara>\r
764 </listitem>\r
765 </varlistentry>\r
766 <varlistentry>\r
767 <term>\r
768 <xref linkend="git-merge-tree(1)"/>\r
769 </term>\r
770 <listitem>\r
771 <simpara>\r
772         Show three-way merge without touching index.\r
773 </simpara>\r
774 </listitem>\r
775 </varlistentry>\r
776 <varlistentry>\r
777 <term>\r
778 <xref linkend="git-rerere(1)"/>\r
779 </term>\r
780 <listitem>\r
781 <simpara>\r
782         Reuse recorded resolution of conflicted merges.\r
783 </simpara>\r
784 </listitem>\r
785 </varlistentry>\r
786 <varlistentry>\r
787 <term>\r
788 <xref linkend="git-rev-parse(1)"/>\r
789 </term>\r
790 <listitem>\r
791 <simpara>\r
792         Pick out and massage parameters.\r
793 </simpara>\r
794 </listitem>\r
795 </varlistentry>\r
796 <varlistentry>\r
797 <term>\r
798 <xref linkend="git-show-branch(1)"/>\r
799 </term>\r
800 <listitem>\r
801 <simpara>\r
802         Show branches and their commits.\r
803 </simpara>\r
804 </listitem>\r
805 </varlistentry>\r
806 <varlistentry>\r
807 <term>\r
808 <xref linkend="git-verify-tag(1)"/>\r
809 </term>\r
810 <listitem>\r
811 <simpara>\r
812         Check the GPG signature of tags.\r
813 </simpara>\r
814 </listitem>\r
815 </varlistentry>\r
816 <varlistentry>\r
817 <term>\r
818 <xref linkend="git-whatchanged(1)"/>\r
819 </term>\r
820 <listitem>\r
821 <simpara>\r
822         Show logs with difference each commit introduces.\r
823 </simpara>\r
824 </listitem>\r
825 </varlistentry>\r
826 </variablelist>\r
827 </simplesect>\r
828 <simplesect id="_interacting_with_others">\r
829 <title>Interacting with Others</title>\r
830 <simpara>These commands are to interact with foreign SCM and with other\r
831 people via patch over e-mail.</simpara>\r
832 <variablelist>\r
833 <varlistentry>\r
834 <term>\r
835 <xref linkend="git-archimport(1)"/>\r
836 </term>\r
837 <listitem>\r
838 <simpara>\r
839         Import an Arch repository into git.\r
840 </simpara>\r
841 </listitem>\r
842 </varlistentry>\r
843 <varlistentry>\r
844 <term>\r
845 <xref linkend="git-cvsexportcommit(1)"/>\r
846 </term>\r
847 <listitem>\r
848 <simpara>\r
849         Export a single commit to a CVS checkout.\r
850 </simpara>\r
851 </listitem>\r
852 </varlistentry>\r
853 <varlistentry>\r
854 <term>\r
855 <xref linkend="git-cvsimport(1)"/>\r
856 </term>\r
857 <listitem>\r
858 <simpara>\r
859         Salvage your data out of another SCM people love to hate.\r
860 </simpara>\r
861 </listitem>\r
862 </varlistentry>\r
863 <varlistentry>\r
864 <term>\r
865 <xref linkend="git-cvsserver(1)"/>\r
866 </term>\r
867 <listitem>\r
868 <simpara>\r
869         A CVS server emulator for git.\r
870 </simpara>\r
871 </listitem>\r
872 </varlistentry>\r
873 <varlistentry>\r
874 <term>\r
875 <xref linkend="git-imap-send(1)"/>\r
876 </term>\r
877 <listitem>\r
878 <simpara>\r
879         Send a collection of patches from stdin to an IMAP folder.\r
880 </simpara>\r
881 </listitem>\r
882 </varlistentry>\r
883 <varlistentry>\r
884 <term>\r
885 <xref linkend="git-quiltimport(1)"/>\r
886 </term>\r
887 <listitem>\r
888 <simpara>\r
889         Applies a quilt patchset onto the current branch.\r
890 </simpara>\r
891 </listitem>\r
892 </varlistentry>\r
893 <varlistentry>\r
894 <term>\r
895 <xref linkend="git-request-pull(1)"/>\r
896 </term>\r
897 <listitem>\r
898 <simpara>\r
899         Generates a summary of pending changes.\r
900 </simpara>\r
901 </listitem>\r
902 </varlistentry>\r
903 <varlistentry>\r
904 <term>\r
905 <xref linkend="git-send-email(1)"/>\r
906 </term>\r
907 <listitem>\r
908 <simpara>\r
909         Send a collection of patches as emails.\r
910 </simpara>\r
911 </listitem>\r
912 </varlistentry>\r
913 <varlistentry>\r
914 <term>\r
915 <xref linkend="git-svn(1)"/>\r
916 </term>\r
917 <listitem>\r
918 <simpara>\r
919         Bidirectional operation between a single Subversion branch and git.\r
920 </simpara>\r
921 </listitem>\r
922 </varlistentry>\r
923 </variablelist>\r
924 </simplesect>\r
925 </simplesect>\r
926 <simplesect id="_low_level_commands_plumbing">\r
927 <title>Low-level commands (plumbing)</title>\r
928 <simpara>Although git includes its\r
929 own porcelain layer, its low-level commands are sufficient to support\r
930 development of alternative porcelains.  Developers of such porcelains\r
931 might start by reading about <xref linkend="git-update-index(1)"/> and\r
932 <xref linkend="git-read-tree(1)"/>.</simpara>\r
933 <simpara>The interface (input, output, set of options and the semantics)\r
934 to these low-level commands are meant to be a lot more stable\r
935 than Porcelain level commands, because these commands are\r
936 primarily for scripted use.  The interface to Porcelain commands\r
937 on the other hand are subject to change in order to improve the\r
938 end user experience.</simpara>\r
939 <simpara>The following description divides\r
940 the low-level commands into commands that manipulate objects (in\r
941 the repository, index, and working tree), commands that interrogate and\r
942 compare objects, and commands that move objects and references between\r
943 repositories.</simpara>\r
944 <simplesect id="_manipulation_commands">\r
945 <title>Manipulation commands</title>\r
946 <variablelist>\r
947 <varlistentry>\r
948 <term>\r
949 <xref linkend="git-apply(1)"/>\r
950 </term>\r
951 <listitem>\r
952 <simpara>\r
953         Apply a patch on a git index file and a working tree.\r
954 </simpara>\r
955 </listitem>\r
956 </varlistentry>\r
957 <varlistentry>\r
958 <term>\r
959 <xref linkend="git-checkout-index(1)"/>\r
960 </term>\r
961 <listitem>\r
962 <simpara>\r
963         Copy files from the index to the working tree.\r
964 </simpara>\r
965 </listitem>\r
966 </varlistentry>\r
967 <varlistentry>\r
968 <term>\r
969 <xref linkend="git-commit-tree(1)"/>\r
970 </term>\r
971 <listitem>\r
972 <simpara>\r
973         Create a new commit object.\r
974 </simpara>\r
975 </listitem>\r
976 </varlistentry>\r
977 <varlistentry>\r
978 <term>\r
979 <xref linkend="git-hash-object(1)"/>\r
980 </term>\r
981 <listitem>\r
982 <simpara>\r
983         Compute object ID and optionally creates a blob from a file.\r
984 </simpara>\r
985 </listitem>\r
986 </varlistentry>\r
987 <varlistentry>\r
988 <term>\r
989 <xref linkend="git-index-pack(1)"/>\r
990 </term>\r
991 <listitem>\r
992 <simpara>\r
993         Build pack index file for an existing packed archive.\r
994 </simpara>\r
995 </listitem>\r
996 </varlistentry>\r
997 <varlistentry>\r
998 <term>\r
999 <xref linkend="git-merge-file(1)"/>\r
1000 </term>\r
1001 <listitem>\r
1002 <simpara>\r
1003         Run a three-way file merge.\r
1004 </simpara>\r
1005 </listitem>\r
1006 </varlistentry>\r
1007 <varlistentry>\r
1008 <term>\r
1009 <xref linkend="git-merge-index(1)"/>\r
1010 </term>\r
1011 <listitem>\r
1012 <simpara>\r
1013         Run a merge for files needing merging.\r
1014 </simpara>\r
1015 </listitem>\r
1016 </varlistentry>\r
1017 <varlistentry>\r
1018 <term>\r
1019 <xref linkend="git-mktag(1)"/>\r
1020 </term>\r
1021 <listitem>\r
1022 <simpara>\r
1023         Creates a tag object.\r
1024 </simpara>\r
1025 </listitem>\r
1026 </varlistentry>\r
1027 <varlistentry>\r
1028 <term>\r
1029 <xref linkend="git-mktree(1)"/>\r
1030 </term>\r
1031 <listitem>\r
1032 <simpara>\r
1033         Build a tree-object from ls-tree formatted text.\r
1034 </simpara>\r
1035 </listitem>\r
1036 </varlistentry>\r
1037 <varlistentry>\r
1038 <term>\r
1039 <xref linkend="git-pack-objects(1)"/>\r
1040 </term>\r
1041 <listitem>\r
1042 <simpara>\r
1043         Create a packed archive of objects.\r
1044 </simpara>\r
1045 </listitem>\r
1046 </varlistentry>\r
1047 <varlistentry>\r
1048 <term>\r
1049 <xref linkend="git-prune-packed(1)"/>\r
1050 </term>\r
1051 <listitem>\r
1052 <simpara>\r
1053         Remove extra objects that are already in pack files.\r
1054 </simpara>\r
1055 </listitem>\r
1056 </varlistentry>\r
1057 <varlistentry>\r
1058 <term>\r
1059 <xref linkend="git-read-tree(1)"/>\r
1060 </term>\r
1061 <listitem>\r
1062 <simpara>\r
1063         Reads tree information into the index.\r
1064 </simpara>\r
1065 </listitem>\r
1066 </varlistentry>\r
1067 <varlistentry>\r
1068 <term>\r
1069 <xref linkend="git-symbolic-ref(1)"/>\r
1070 </term>\r
1071 <listitem>\r
1072 <simpara>\r
1073         Read and modify symbolic refs.\r
1074 </simpara>\r
1075 </listitem>\r
1076 </varlistentry>\r
1077 <varlistentry>\r
1078 <term>\r
1079 <xref linkend="git-unpack-objects(1)"/>\r
1080 </term>\r
1081 <listitem>\r
1082 <simpara>\r
1083         Unpack objects from a packed archive.\r
1084 </simpara>\r
1085 </listitem>\r
1086 </varlistentry>\r
1087 <varlistentry>\r
1088 <term>\r
1089 <xref linkend="git-update-index(1)"/>\r
1090 </term>\r
1091 <listitem>\r
1092 <simpara>\r
1093         Register file contents in the working tree to the index.\r
1094 </simpara>\r
1095 </listitem>\r
1096 </varlistentry>\r
1097 <varlistentry>\r
1098 <term>\r
1099 <xref linkend="git-update-ref(1)"/>\r
1100 </term>\r
1101 <listitem>\r
1102 <simpara>\r
1103         Update the object name stored in a ref safely.\r
1104 </simpara>\r
1105 </listitem>\r
1106 </varlistentry>\r
1107 <varlistentry>\r
1108 <term>\r
1109 <xref linkend="git-write-tree(1)"/>\r
1110 </term>\r
1111 <listitem>\r
1112 <simpara>\r
1113         Create a tree object from the current index.\r
1114 </simpara>\r
1115 </listitem>\r
1116 </varlistentry>\r
1117 </variablelist>\r
1118 </simplesect>\r
1119 <simplesect id="_interrogation_commands">\r
1120 <title>Interrogation commands</title>\r
1121 <variablelist>\r
1122 <varlistentry>\r
1123 <term>\r
1124 <xref linkend="git-cat-file(1)"/>\r
1125 </term>\r
1126 <listitem>\r
1127 <simpara>\r
1128         Provide content or type/size information for repository objects.\r
1129 </simpara>\r
1130 </listitem>\r
1131 </varlistentry>\r
1132 <varlistentry>\r
1133 <term>\r
1134 <xref linkend="git-diff-files(1)"/>\r
1135 </term>\r
1136 <listitem>\r
1137 <simpara>\r
1138         Compares files in the working tree and the index.\r
1139 </simpara>\r
1140 </listitem>\r
1141 </varlistentry>\r
1142 <varlistentry>\r
1143 <term>\r
1144 <xref linkend="git-diff-index(1)"/>\r
1145 </term>\r
1146 <listitem>\r
1147 <simpara>\r
1148         Compares content and mode of blobs between the index and repository.\r
1149 </simpara>\r
1150 </listitem>\r
1151 </varlistentry>\r
1152 <varlistentry>\r
1153 <term>\r
1154 <xref linkend="git-diff-tree(1)"/>\r
1155 </term>\r
1156 <listitem>\r
1157 <simpara>\r
1158         Compares the content and mode of blobs found via two tree objects.\r
1159 </simpara>\r
1160 </listitem>\r
1161 </varlistentry>\r
1162 <varlistentry>\r
1163 <term>\r
1164 <xref linkend="git-for-each-ref(1)"/>\r
1165 </term>\r
1166 <listitem>\r
1167 <simpara>\r
1168         Output information on each ref.\r
1169 </simpara>\r
1170 </listitem>\r
1171 </varlistentry>\r
1172 <varlistentry>\r
1173 <term>\r
1174 <xref linkend="git-ls-files(1)"/>\r
1175 </term>\r
1176 <listitem>\r
1177 <simpara>\r
1178         Show information about files in the index and the working tree.\r
1179 </simpara>\r
1180 </listitem>\r
1181 </varlistentry>\r
1182 <varlistentry>\r
1183 <term>\r
1184 <xref linkend="git-ls-remote(1)"/>\r
1185 </term>\r
1186 <listitem>\r
1187 <simpara>\r
1188         List references in a remote repository.\r
1189 </simpara>\r
1190 </listitem>\r
1191 </varlistentry>\r
1192 <varlistentry>\r
1193 <term>\r
1194 <xref linkend="git-ls-tree(1)"/>\r
1195 </term>\r
1196 <listitem>\r
1197 <simpara>\r
1198         List the contents of a tree object.\r
1199 </simpara>\r
1200 </listitem>\r
1201 </varlistentry>\r
1202 <varlistentry>\r
1203 <term>\r
1204 <xref linkend="git-merge-base(1)"/>\r
1205 </term>\r
1206 <listitem>\r
1207 <simpara>\r
1208         Find as good common ancestors as possible for a merge.\r
1209 </simpara>\r
1210 </listitem>\r
1211 </varlistentry>\r
1212 <varlistentry>\r
1213 <term>\r
1214 <xref linkend="git-name-rev(1)"/>\r
1215 </term>\r
1216 <listitem>\r
1217 <simpara>\r
1218         Find symbolic names for given revs.\r
1219 </simpara>\r
1220 </listitem>\r
1221 </varlistentry>\r
1222 <varlistentry>\r
1223 <term>\r
1224 <xref linkend="git-pack-redundant(1)"/>\r
1225 </term>\r
1226 <listitem>\r
1227 <simpara>\r
1228         Find redundant pack files.\r
1229 </simpara>\r
1230 </listitem>\r
1231 </varlistentry>\r
1232 <varlistentry>\r
1233 <term>\r
1234 <xref linkend="git-rev-list(1)"/>\r
1235 </term>\r
1236 <listitem>\r
1237 <simpara>\r
1238         Lists commit objects in reverse chronological order.\r
1239 </simpara>\r
1240 </listitem>\r
1241 </varlistentry>\r
1242 <varlistentry>\r
1243 <term>\r
1244 <xref linkend="git-show-index(1)"/>\r
1245 </term>\r
1246 <listitem>\r
1247 <simpara>\r
1248         Show packed archive index.\r
1249 </simpara>\r
1250 </listitem>\r
1251 </varlistentry>\r
1252 <varlistentry>\r
1253 <term>\r
1254 <xref linkend="git-show-ref(1)"/>\r
1255 </term>\r
1256 <listitem>\r
1257 <simpara>\r
1258         List references in a local repository.\r
1259 </simpara>\r
1260 </listitem>\r
1261 </varlistentry>\r
1262 <varlistentry>\r
1263 <term>\r
1264 <xref linkend="git-tar-tree(1)"/>\r
1265 </term>\r
1266 <listitem>\r
1267 <simpara>\r
1268         (deprecated) Create a tar archive of the files in the named tree object.\r
1269 </simpara>\r
1270 </listitem>\r
1271 </varlistentry>\r
1272 <varlistentry>\r
1273 <term>\r
1274 <xref linkend="git-unpack-file(1)"/>\r
1275 </term>\r
1276 <listitem>\r
1277 <simpara>\r
1278         Creates a temporary file with a blob&#8217;s contents.\r
1279 </simpara>\r
1280 </listitem>\r
1281 </varlistentry>\r
1282 <varlistentry>\r
1283 <term>\r
1284 <xref linkend="git-var(1)"/>\r
1285 </term>\r
1286 <listitem>\r
1287 <simpara>\r
1288         Show a git logical variable.\r
1289 </simpara>\r
1290 </listitem>\r
1291 </varlistentry>\r
1292 <varlistentry>\r
1293 <term>\r
1294 <xref linkend="git-verify-pack(1)"/>\r
1295 </term>\r
1296 <listitem>\r
1297 <simpara>\r
1298         Validate packed git archive files.\r
1299 </simpara>\r
1300 </listitem>\r
1301 </varlistentry>\r
1302 </variablelist>\r
1303 <simpara>In general, the interrogate commands do not touch the files in\r
1304 the working tree.</simpara>\r
1305 </simplesect>\r
1306 <simplesect id="_synching_repositories">\r
1307 <title>Synching repositories</title>\r
1308 <variablelist>\r
1309 <varlistentry>\r
1310 <term>\r
1311 <xref linkend="git-daemon(1)"/>\r
1312 </term>\r
1313 <listitem>\r
1314 <simpara>\r
1315         A really simple server for git repositories.\r
1316 </simpara>\r
1317 </listitem>\r
1318 </varlistentry>\r
1319 <varlistentry>\r
1320 <term>\r
1321 <xref linkend="git-fetch-pack(1)"/>\r
1322 </term>\r
1323 <listitem>\r
1324 <simpara>\r
1325         Receive missing objects from another repository.\r
1326 </simpara>\r
1327 </listitem>\r
1328 </varlistentry>\r
1329 <varlistentry>\r
1330 <term>\r
1331 <xref linkend="git-send-pack(1)"/>\r
1332 </term>\r
1333 <listitem>\r
1334 <simpara>\r
1335         Push objects over git protocol to another repository.\r
1336 </simpara>\r
1337 </listitem>\r
1338 </varlistentry>\r
1339 <varlistentry>\r
1340 <term>\r
1341 <xref linkend="git-update-server-info(1)"/>\r
1342 </term>\r
1343 <listitem>\r
1344 <simpara>\r
1345         Update auxiliary info file to help dumb servers.\r
1346 </simpara>\r
1347 </listitem>\r
1348 </varlistentry>\r
1349 </variablelist>\r
1350 <simpara>The following are helper programs used by the above; end users\r
1351 typically do not use them directly.</simpara>\r
1352 <variablelist>\r
1353 <varlistentry>\r
1354 <term>\r
1355 <xref linkend="git-http-fetch(1)"/>\r
1356 </term>\r
1357 <listitem>\r
1358 <simpara>\r
1359         Download from a remote git repository via HTTP.\r
1360 </simpara>\r
1361 </listitem>\r
1362 </varlistentry>\r
1363 <varlistentry>\r
1364 <term>\r
1365 <xref linkend="git-http-push(1)"/>\r
1366 </term>\r
1367 <listitem>\r
1368 <simpara>\r
1369         Push objects over HTTP/DAV to another repository.\r
1370 </simpara>\r
1371 </listitem>\r
1372 </varlistentry>\r
1373 <varlistentry>\r
1374 <term>\r
1375 <xref linkend="git-parse-remote(1)"/>\r
1376 </term>\r
1377 <listitem>\r
1378 <simpara>\r
1379         Routines to help parsing remote repository access parameters.\r
1380 </simpara>\r
1381 </listitem>\r
1382 </varlistentry>\r
1383 <varlistentry>\r
1384 <term>\r
1385 <xref linkend="git-receive-pack(1)"/>\r
1386 </term>\r
1387 <listitem>\r
1388 <simpara>\r
1389         Receive what is pushed into the repository.\r
1390 </simpara>\r
1391 </listitem>\r
1392 </varlistentry>\r
1393 <varlistentry>\r
1394 <term>\r
1395 <xref linkend="git-shell(1)"/>\r
1396 </term>\r
1397 <listitem>\r
1398 <simpara>\r
1399         Restricted login shell for GIT-only SSH access.\r
1400 </simpara>\r
1401 </listitem>\r
1402 </varlistentry>\r
1403 <varlistentry>\r
1404 <term>\r
1405 <xref linkend="git-upload-archive(1)"/>\r
1406 </term>\r
1407 <listitem>\r
1408 <simpara>\r
1409         Send archive back to git-archive.\r
1410 </simpara>\r
1411 </listitem>\r
1412 </varlistentry>\r
1413 <varlistentry>\r
1414 <term>\r
1415 <xref linkend="git-upload-pack(1)"/>\r
1416 </term>\r
1417 <listitem>\r
1418 <simpara>\r
1419         Send objects packed back to git-fetch-pack.\r
1420 </simpara>\r
1421 </listitem>\r
1422 </varlistentry>\r
1423 </variablelist>\r
1424 </simplesect>\r
1425 <simplesect id="_internal_helper_commands">\r
1426 <title>Internal helper commands</title>\r
1427 <simpara>These are internal helper commands used by other commands; end\r
1428 users typically do not use them directly.</simpara>\r
1429 <variablelist>\r
1430 <varlistentry>\r
1431 <term>\r
1432 <xref linkend="git-check-attr(1)"/>\r
1433 </term>\r
1434 <listitem>\r
1435 <simpara>\r
1436         Display gitattributes information.\r
1437 </simpara>\r
1438 </listitem>\r
1439 </varlistentry>\r
1440 <varlistentry>\r
1441 <term>\r
1442 <xref linkend="git-check-ref-format(1)"/>\r
1443 </term>\r
1444 <listitem>\r
1445 <simpara>\r
1446         Make sure ref name is well formed.\r
1447 </simpara>\r
1448 </listitem>\r
1449 </varlistentry>\r
1450 <varlistentry>\r
1451 <term>\r
1452 <xref linkend="git-fmt-merge-msg(1)"/>\r
1453 </term>\r
1454 <listitem>\r
1455 <simpara>\r
1456         Produce a merge commit message.\r
1457 </simpara>\r
1458 </listitem>\r
1459 </varlistentry>\r
1460 <varlistentry>\r
1461 <term>\r
1462 <xref linkend="git-mailinfo(1)"/>\r
1463 </term>\r
1464 <listitem>\r
1465 <simpara>\r
1466         Extracts patch and authorship from a single e-mail message.\r
1467 </simpara>\r
1468 </listitem>\r
1469 </varlistentry>\r
1470 <varlistentry>\r
1471 <term>\r
1472 <xref linkend="git-mailsplit(1)"/>\r
1473 </term>\r
1474 <listitem>\r
1475 <simpara>\r
1476         Simple UNIX mbox splitter program.\r
1477 </simpara>\r
1478 </listitem>\r
1479 </varlistentry>\r
1480 <varlistentry>\r
1481 <term>\r
1482 <xref linkend="git-merge-one-file(1)"/>\r
1483 </term>\r
1484 <listitem>\r
1485 <simpara>\r
1486         The standard helper program to use with git-merge-index.\r
1487 </simpara>\r
1488 </listitem>\r
1489 </varlistentry>\r
1490 <varlistentry>\r
1491 <term>\r
1492 <xref linkend="git-patch-id(1)"/>\r
1493 </term>\r
1494 <listitem>\r
1495 <simpara>\r
1496         Compute unique ID for a patch.\r
1497 </simpara>\r
1498 </listitem>\r
1499 </varlistentry>\r
1500 <varlistentry>\r
1501 <term>\r
1502 <xref linkend="git-peek-remote(1)"/>\r
1503 </term>\r
1504 <listitem>\r
1505 <simpara>\r
1506         (deprecated) List the references in a remote repository.\r
1507 </simpara>\r
1508 </listitem>\r
1509 </varlistentry>\r
1510 <varlistentry>\r
1511 <term>\r
1512 <xref linkend="git-sh-setup(1)"/>\r
1513 </term>\r
1514 <listitem>\r
1515 <simpara>\r
1516         Common git shell script setup code.\r
1517 </simpara>\r
1518 </listitem>\r
1519 </varlistentry>\r
1520 <varlistentry>\r
1521 <term>\r
1522 <xref linkend="git-stripspace(1)"/>\r
1523 </term>\r
1524 <listitem>\r
1525 <simpara>\r
1526         Filter out empty lines.\r
1527 </simpara>\r
1528 </listitem>\r
1529 </varlistentry>\r
1530 </variablelist>\r
1531 </simplesect>\r
1532 </simplesect>\r
1533 <simplesect id="_configuration_mechanism">\r
1534 <title>Configuration Mechanism</title>\r
1535 <simpara>Starting from 0.99.9 (actually mid 0.99.8.GIT), <literal>.git/config</literal> file\r
1536 is used to hold per-repository configuration options.  It is a\r
1537 simple text file modeled after <literal>.ini</literal> format familiar to some\r
1538 people.  Here is an example:</simpara>\r
1539 <literallayout>#\r
1540 # A '#' or ';' character indicates a comment.\r
1541 #\r
1542 \r
1543 ; core variables\r
1544 [core]\r
1545         ; Don't trust file modes\r
1546         filemode = false\r
1547 \r
1548 ; user identity\r
1549 [user]\r
1550         name = "Junio C Hamano"\r
1551         email = "junkio@twinsun.com"</literallayout>\r
1552 <simpara>Various commands read from the configuration file and adjust\r
1553 their operation accordingly.</simpara>\r
1554 </simplesect>\r
1555 <simplesect id="_identifier_terminology">\r
1556 <title>Identifier Terminology</title>\r
1557 <variablelist>\r
1558 <varlistentry>\r
1559 <term>\r
1560 &lt;object&gt;\r
1561 </term>\r
1562 <listitem>\r
1563 <simpara>\r
1564         Indicates the object name for any type of object.\r
1565 </simpara>\r
1566 </listitem>\r
1567 </varlistentry>\r
1568 <varlistentry>\r
1569 <term>\r
1570 &lt;blob&gt;\r
1571 </term>\r
1572 <listitem>\r
1573 <simpara>\r
1574         Indicates a blob object name.\r
1575 </simpara>\r
1576 </listitem>\r
1577 </varlistentry>\r
1578 <varlistentry>\r
1579 <term>\r
1580 &lt;tree&gt;\r
1581 </term>\r
1582 <listitem>\r
1583 <simpara>\r
1584         Indicates a tree object name.\r
1585 </simpara>\r
1586 </listitem>\r
1587 </varlistentry>\r
1588 <varlistentry>\r
1589 <term>\r
1590 &lt;commit&gt;\r
1591 </term>\r
1592 <listitem>\r
1593 <simpara>\r
1594         Indicates a commit object name.\r
1595 </simpara>\r
1596 </listitem>\r
1597 </varlistentry>\r
1598 <varlistentry>\r
1599 <term>\r
1600 &lt;tree-ish&gt;\r
1601 </term>\r
1602 <listitem>\r
1603 <simpara>\r
1604         Indicates a tree, commit or tag object name.  A\r
1605         command that takes a &lt;tree-ish&gt; argument ultimately wants to\r
1606         operate on a &lt;tree&gt; object but automatically dereferences\r
1607         &lt;commit&gt; and &lt;tag&gt; objects that point at a &lt;tree&gt;.\r
1608 </simpara>\r
1609 </listitem>\r
1610 </varlistentry>\r
1611 <varlistentry>\r
1612 <term>\r
1613 &lt;commit-ish&gt;\r
1614 </term>\r
1615 <listitem>\r
1616 <simpara>\r
1617         Indicates a commit or tag object name.  A\r
1618         command that takes a &lt;commit-ish&gt; argument ultimately wants to\r
1619         operate on a &lt;commit&gt; object but automatically dereferences\r
1620         &lt;tag&gt; objects that point at a &lt;commit&gt;.\r
1621 </simpara>\r
1622 </listitem>\r
1623 </varlistentry>\r
1624 <varlistentry>\r
1625 <term>\r
1626 &lt;type&gt;\r
1627 </term>\r
1628 <listitem>\r
1629 <simpara>\r
1630         Indicates that an object type is required.\r
1631         Currently one of: <literal>blob</literal>, <literal>tree</literal>, <literal>commit</literal>, or <literal>tag</literal>.\r
1632 </simpara>\r
1633 </listitem>\r
1634 </varlistentry>\r
1635 <varlistentry>\r
1636 <term>\r
1637 &lt;file&gt;\r
1638 </term>\r
1639 <listitem>\r
1640 <simpara>\r
1641         Indicates a filename - almost always relative to the\r
1642         root of the tree structure <literal>GIT_INDEX_FILE</literal> describes.\r
1643 </simpara>\r
1644 </listitem>\r
1645 </varlistentry>\r
1646 </variablelist>\r
1647 </simplesect>\r
1648 <simplesect id="_symbolic_identifiers">\r
1649 <title>Symbolic Identifiers</title>\r
1650 <simpara>Any git command accepting any &lt;object&gt; can also use the following\r
1651 symbolic notation:</simpara>\r
1652 <variablelist>\r
1653 <varlistentry>\r
1654 <term>\r
1655 HEAD\r
1656 </term>\r
1657 <listitem>\r
1658 <simpara>\r
1659         indicates the head of the current branch (i.e. the\r
1660         contents of <literal>$GIT_DIR/HEAD</literal>).\r
1661 </simpara>\r
1662 </listitem>\r
1663 </varlistentry>\r
1664 <varlistentry>\r
1665 <term>\r
1666 &lt;tag&gt;\r
1667 </term>\r
1668 <listitem>\r
1669 <simpara>\r
1670         a valid tag <emphasis>name</emphasis>\r
1671         (i.e. the contents of <literal>$GIT_DIR/refs/tags/&lt;tag&gt;</literal>).\r
1672 </simpara>\r
1673 </listitem>\r
1674 </varlistentry>\r
1675 <varlistentry>\r
1676 <term>\r
1677 &lt;head&gt;\r
1678 </term>\r
1679 <listitem>\r
1680 <simpara>\r
1681         a valid head <emphasis>name</emphasis>\r
1682         (i.e. the contents of <literal>$GIT_DIR/refs/heads/&lt;head&gt;</literal>).\r
1683 </simpara>\r
1684 </listitem>\r
1685 </varlistentry>\r
1686 </variablelist>\r
1687 <simpara>For a more complete list of ways to spell object names, see\r
1688 "SPECIFYING REVISIONS" section in <xref linkend="git-rev-parse(1)"/>.</simpara>\r
1689 </simplesect>\r
1690 <simplesect id="_file_directory_structure">\r
1691 <title>File/Directory Structure</title>\r
1692 <simpara>Please see the <xref linkend="gitrepository-layout(5)"/> document.</simpara>\r
1693 <simpara>Read <xref linkend="githooks(5)"/> for more details about each hook.</simpara>\r
1694 <simpara>Higher level SCMs may provide and manage additional information in the\r
1695 <literal>$GIT_DIR</literal>.</simpara>\r
1696 </simplesect>\r
1697 <simplesect id="_terminology">\r
1698 <title>Terminology</title>\r
1699 <simpara>Please see <xref linkend="gitglossary(7)"/>.</simpara>\r
1700 </simplesect>\r
1701 <simplesect id="_environment_variables">\r
1702 <title>Environment Variables</title>\r
1703 <simpara>Various git commands use the following environment variables:</simpara>\r
1704 <simplesect id="_the_git_repository">\r
1705 <title>The git Repository</title>\r
1706 <simpara>These environment variables apply to <emphasis>all</emphasis> core git commands. Nb: it\r
1707 is worth noting that they may be used/overridden by SCMS sitting above\r
1708 git so take care if using Cogito etc.</simpara>\r
1709 <variablelist>\r
1710 <varlistentry>\r
1711 <term>\r
1712 <emphasis>GIT_INDEX_FILE</emphasis>\r
1713 </term>\r
1714 <listitem>\r
1715 <simpara>\r
1716         This environment allows the specification of an alternate\r
1717         index file. If not specified, the default of <literal>$GIT_DIR/index</literal>\r
1718         is used.\r
1719 </simpara>\r
1720 </listitem>\r
1721 </varlistentry>\r
1722 <varlistentry>\r
1723 <term>\r
1724 <emphasis>GIT_OBJECT_DIRECTORY</emphasis>\r
1725 </term>\r
1726 <listitem>\r
1727 <simpara>\r
1728         If the object storage directory is specified via this\r
1729         environment variable then the sha1 directories are created\r
1730         underneath - otherwise the default <literal>$GIT_DIR/objects</literal>\r
1731         directory is used.\r
1732 </simpara>\r
1733 </listitem>\r
1734 </varlistentry>\r
1735 <varlistentry>\r
1736 <term>\r
1737 <emphasis>GIT_ALTERNATE_OBJECT_DIRECTORIES</emphasis>\r
1738 </term>\r
1739 <listitem>\r
1740 <simpara>\r
1741         Due to the immutable nature of git objects, old objects can be\r
1742         archived into shared, read-only directories. This variable\r
1743         specifies a ":" separated (on Windows ";" separated) list\r
1744         of git object directories which can be used to search for git\r
1745         objects. New objects will not be written to these directories.\r
1746 </simpara>\r
1747 </listitem>\r
1748 </varlistentry>\r
1749 <varlistentry>\r
1750 <term>\r
1751 <emphasis>GIT_DIR</emphasis>\r
1752 </term>\r
1753 <listitem>\r
1754 <simpara>\r
1755         If the <emphasis>GIT_DIR</emphasis> environment variable is set then it\r
1756         specifies a path to use instead of the default <literal>.git</literal>\r
1757         for the base of the repository.\r
1758 </simpara>\r
1759 </listitem>\r
1760 </varlistentry>\r
1761 <varlistentry>\r
1762 <term>\r
1763 <emphasis>GIT_WORK_TREE</emphasis>\r
1764 </term>\r
1765 <listitem>\r
1766 <simpara>\r
1767         Set the path to the working tree.  The value will not be\r
1768         used in combination with repositories found automatically in\r
1769         a .git directory (i.e. $GIT_DIR is not set).\r
1770         This can also be controlled by the <emphasis>--work-tree</emphasis> command line\r
1771         option and the core.worktree configuration variable.\r
1772 </simpara>\r
1773 </listitem>\r
1774 </varlistentry>\r
1775 <varlistentry>\r
1776 <term>\r
1777 <emphasis>GIT_CEILING_DIRECTORIES</emphasis>\r
1778 </term>\r
1779 <listitem>\r
1780 <simpara>\r
1781         This should be a colon-separated list of absolute paths.\r
1782         If set, it is a list of directories that git should not chdir\r
1783         up into while looking for a repository directory.\r
1784         It will not exclude the current working directory or\r
1785         a GIT_DIR set on the command line or in the environment.\r
1786         (Useful for excluding slow-loading network directories.)\r
1787 </simpara>\r
1788 </listitem>\r
1789 </varlistentry>\r
1790 </variablelist>\r
1791 </simplesect>\r
1792 <simplesect id="_git_commits">\r
1793 <title>git Commits</title>\r
1794 <variablelist>\r
1795 <varlistentry>\r
1796 <term>\r
1797 <emphasis>GIT_AUTHOR_NAME</emphasis>\r
1798 </term>\r
1799 <term>\r
1800 <emphasis>GIT_AUTHOR_EMAIL</emphasis>\r
1801 </term>\r
1802 <term>\r
1803 <emphasis>GIT_AUTHOR_DATE</emphasis>\r
1804 </term>\r
1805 <term>\r
1806 <emphasis>GIT_COMMITTER_NAME</emphasis>\r
1807 </term>\r
1808 <term>\r
1809 <emphasis>GIT_COMMITTER_EMAIL</emphasis>\r
1810 </term>\r
1811 <term>\r
1812 <emphasis>GIT_COMMITTER_DATE</emphasis>\r
1813 </term>\r
1814 <term>\r
1815 <emphasis>EMAIL</emphasis>\r
1816 </term>\r
1817 <listitem>\r
1818 <simpara>\r
1819         see <xref linkend="git-commit-tree(1)"/>\r
1820 </simpara>\r
1821 </listitem>\r
1822 </varlistentry>\r
1823 </variablelist>\r
1824 </simplesect>\r
1825 <simplesect id="_git_diffs">\r
1826 <title>git Diffs</title>\r
1827 <variablelist>\r
1828 <varlistentry>\r
1829 <term>\r
1830 <emphasis>GIT_DIFF_OPTS</emphasis>\r
1831 </term>\r
1832 <listitem>\r
1833 <simpara>\r
1834         Only valid setting is "--unified=??" or "-u??" to set the\r
1835         number of context lines shown when a unified diff is created.\r
1836         This takes precedence over any "-U" or "--unified" option\r
1837         value passed on the git diff command line.\r
1838 </simpara>\r
1839 </listitem>\r
1840 </varlistentry>\r
1841 <varlistentry>\r
1842 <term>\r
1843 <emphasis>GIT_EXTERNAL_DIFF</emphasis>\r
1844 </term>\r
1845 <listitem>\r
1846 <simpara>\r
1847         When the environment variable <emphasis>GIT_EXTERNAL_DIFF</emphasis> is set, the\r
1848         program named by it is called, instead of the diff invocation\r
1849         described above.  For a path that is added, removed, or modified,\r
1850         <emphasis>GIT_EXTERNAL_DIFF</emphasis> is called with 7 parameters:\r
1851 </simpara>\r
1852 <literallayout class="monospaced">path old-file old-hex old-mode new-file new-hex new-mode</literallayout>\r
1853 <simpara>where:</simpara>\r
1854 </listitem>\r
1855 </varlistentry>\r
1856 <varlistentry>\r
1857 <term>\r
1858 &lt;old|new&gt;-file\r
1859 </term>\r
1860 <listitem>\r
1861 <simpara>\r
1862 are files GIT_EXTERNAL_DIFF can use to read the\r
1863                          contents of &lt;old|new&gt;,\r
1864 </simpara>\r
1865 </listitem>\r
1866 </varlistentry>\r
1867 <varlistentry>\r
1868 <term>\r
1869 &lt;old|new&gt;-hex\r
1870 </term>\r
1871 <listitem>\r
1872 <simpara>\r
1873 are the 40-hexdigit SHA1 hashes,\r
1874 </simpara>\r
1875 </listitem>\r
1876 </varlistentry>\r
1877 <varlistentry>\r
1878 <term>\r
1879 &lt;old|new&gt;-mode\r
1880 </term>\r
1881 <listitem>\r
1882 <simpara>\r
1883 are the octal representation of the file modes.\r
1884 </simpara>\r
1885 </listitem>\r
1886 </varlistentry>\r
1887 </variablelist>\r
1888 <simpara>+\r
1889 The file parameters can point at the user&#8217;s working file\r
1890 (e.g. <literal>new-file</literal> in "git-diff-files"), <literal>/dev/null</literal> (e.g. <literal>old-file</literal>\r
1891 when a new file is added), or a temporary file (e.g. <literal>old-file</literal> in the\r
1892 index).  <emphasis>GIT_EXTERNAL_DIFF</emphasis> should not worry about unlinking the\r
1893 temporary file --- it is removed when <emphasis>GIT_EXTERNAL_DIFF</emphasis> exits.</simpara>\r
1894 <simpara>+\r
1895 For a path that is unmerged, <emphasis>GIT_EXTERNAL_DIFF</emphasis> is called with 1\r
1896 parameter, &lt;path&gt;.</simpara>\r
1897 </simplesect>\r
1898 <simplesect id="_other">\r
1899 <title>other</title>\r
1900 <variablelist>\r
1901 <varlistentry>\r
1902 <term>\r
1903 <emphasis>GIT_MERGE_VERBOSITY</emphasis>\r
1904 </term>\r
1905 <listitem>\r
1906 <simpara>\r
1907         A number controlling the amount of output shown by\r
1908         the recursive merge strategy.  Overrides merge.verbosity.\r
1909         See <xref linkend="git-merge(1)"/>\r
1910 </simpara>\r
1911 </listitem>\r
1912 </varlistentry>\r
1913 <varlistentry>\r
1914 <term>\r
1915 <emphasis>GIT_PAGER</emphasis>\r
1916 </term>\r
1917 <listitem>\r
1918 <simpara>\r
1919         This environment variable overrides <literal>$PAGER</literal>. If it is set\r
1920         to an empty string or to the value "cat", git will not launch\r
1921         a pager.  See also the <literal>core.pager</literal> option in\r
1922         <xref linkend="git-config(1)"/>.\r
1923 </simpara>\r
1924 </listitem>\r
1925 </varlistentry>\r
1926 <varlistentry>\r
1927 <term>\r
1928 <emphasis>GIT_SSH</emphasis>\r
1929 </term>\r
1930 <listitem>\r
1931 <simpara>\r
1932         If this environment variable is set then <emphasis>git-fetch</emphasis>\r
1933         and <emphasis>git-push</emphasis> will use this command instead\r
1934         of <emphasis>ssh</emphasis> when they need to connect to a remote system.\r
1935         The <emphasis>$GIT_SSH</emphasis> command will be given exactly two arguments:\r
1936         the <emphasis>username@host</emphasis> (or just <emphasis>host</emphasis>) from the URL and the\r
1937         shell command to execute on that remote system.\r
1938 </simpara>\r
1939 <simpara>To pass options to the program that you want to list in GIT_SSH\r
1940 you will need to wrap the program and options into a shell script,\r
1941 then set GIT_SSH to refer to the shell script.</simpara>\r
1942 <simpara>Usually it is easier to configure any desired options through your\r
1943 personal <literal>.ssh/config</literal> file.  Please consult your ssh documentation\r
1944 for further details.</simpara>\r
1945 </listitem>\r
1946 </varlistentry>\r
1947 <varlistentry>\r
1948 <term>\r
1949 <emphasis>GIT_FLUSH</emphasis>\r
1950 </term>\r
1951 <listitem>\r
1952 <simpara>\r
1953         If this environment variable is set to "1", then commands such\r
1954         as <emphasis>git-blame</emphasis> (in incremental mode), <emphasis>git-rev-list</emphasis>, <emphasis>git-log</emphasis>,\r
1955         and <emphasis>git-whatchanged</emphasis> will force a flush of the output stream\r
1956         after each commit-oriented record have been flushed.   If this\r
1957         variable is set to "0", the output of these commands will be done\r
1958         using completely buffered I/O.   If this environment variable is\r
1959         not set, git will choose buffered or record-oriented flushing\r
1960         based on whether stdout appears to be redirected to a file or not.\r
1961 </simpara>\r
1962 </listitem>\r
1963 </varlistentry>\r
1964 <varlistentry>\r
1965 <term>\r
1966 <emphasis>GIT_TRACE</emphasis>\r
1967 </term>\r
1968 <listitem>\r
1969 <simpara>\r
1970         If this variable is set to "1", "2" or "true" (comparison\r
1971         is case insensitive), git will print <literal>trace:</literal> messages on\r
1972         stderr telling about alias expansion, built-in command\r
1973         execution and external command execution.\r
1974         If this variable is set to an integer value greater than 1\r
1975         and lower than 10 (strictly) then git will interpret this\r
1976         value as an open file descriptor and will try to write the\r
1977         trace messages into this file descriptor.\r
1978         Alternatively, if this variable is set to an absolute path\r
1979         (starting with a <emphasis>/</emphasis> character), git will interpret this\r
1980         as a file path and will try to write the trace messages\r
1981         into it.\r
1982 </simpara>\r
1983 </listitem>\r
1984 </varlistentry>\r
1985 </variablelist>\r
1986 </simplesect>\r
1987 </simplesect>\r
1988 <simplesect id="_discussion_anchor_id_discussion_xreflabel_discussion">\r
1989 <title>Discussion<anchor id="Discussion" xreflabel="[Discussion]"/></title>\r
1990 <simpara>More detail on the following is available from the\r
1991 <ulink url="user-manual.html#git-concepts">git concepts chapter of the\r
1992 user-manual</ulink> and <xref linkend="gitcore-tutorial(7)"/>.</simpara>\r
1993 <simpara>A git project normally consists of a working directory with a ".git"\r
1994 subdirectory at the top level.  The .git directory contains, among other\r
1995 things, a compressed object database representing the complete history\r
1996 of the project, an "index" file which links that history to the current\r
1997 contents of the working tree, and named pointers into that history such\r
1998 as tags and branch heads.</simpara>\r
1999 <simpara>The object database contains objects of three main types: blobs, which\r
2000 hold file data; trees, which point to blobs and other trees to build up\r
2001 directory hierarchies; and commits, which each reference a single tree\r
2002 and some number of parent commits.</simpara>\r
2003 <simpara>The commit, equivalent to what other systems call a "changeset" or\r
2004 "version", represents a step in the project&#8217;s history, and each parent\r
2005 represents an immediately preceding step.  Commits with more than one\r
2006 parent represent merges of independent lines of development.</simpara>\r
2007 <simpara>All objects are named by the SHA1 hash of their contents, normally\r
2008 written as a string of 40 hex digits.  Such names are globally unique.\r
2009 The entire history leading up to a commit can be vouched for by signing\r
2010 just that commit.  A fourth object type, the tag, is provided for this\r
2011 purpose.</simpara>\r
2012 <simpara>When first created, objects are stored in individual files, but for\r
2013 efficiency may later be compressed together into "pack files".</simpara>\r
2014 <simpara>Named pointers called refs mark interesting points in history.  A ref\r
2015 may contain the SHA1 name of an object or the name of another ref.  Refs\r
2016 with names beginning <literal>ref/head/</literal> contain the SHA1 name of the most\r
2017 recent commit (or "head") of a branch under development.  SHA1 names of\r
2018 tags of interest are stored under <literal>ref/tags/</literal>.  A special ref named\r
2019 <literal>HEAD</literal> contains the name of the currently checked-out branch.</simpara>\r
2020 <simpara>The index file is initialized with a list of all paths and, for each\r
2021 path, a blob object and a set of attributes.  The blob object represents\r
2022 the contents of the file as of the head of the current branch.  The\r
2023 attributes (last modified time, size, etc.) are taken from the\r
2024 corresponding file in the working tree.  Subsequent changes to the\r
2025 working tree can be found by comparing these attributes.  The index may\r
2026 be updated with new content, and new commits may be created from the\r
2027 content stored in the index.</simpara>\r
2028 <simpara>The index is also capable of storing multiple entries (called "stages")\r
2029 for a given pathname.  These stages are used to hold the various\r
2030 unmerged version of a file when a merge is in progress.</simpara>\r
2031 </simplesect>\r
2032 <simplesect id="_authors">\r
2033 <title>Authors</title>\r
2034 <itemizedlist>\r
2035 <listitem>\r
2036 <simpara>\r
2037 git&#8217;s founding father is Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;.\r
2038 </simpara>\r
2039 </listitem>\r
2040 <listitem>\r
2041 <simpara>\r
2042 The current git nurse is Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;.\r
2043 </simpara>\r
2044 </listitem>\r
2045 <listitem>\r
2046 <simpara>\r
2047 The git potty was written by Andreas Ericsson &lt;<ulink url="mailto:ae@op5.se">ae@op5.se</ulink>&gt;.\r
2048 </simpara>\r
2049 </listitem>\r
2050 <listitem>\r
2051 <simpara>\r
2052 General upbringing is handled by the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.\r
2053 </simpara>\r
2054 </listitem>\r
2055 </itemizedlist>\r
2056 </simplesect>\r
2057 <simplesect id="_documentation">\r
2058 <title>Documentation</title>\r
2059 <simpara>The documentation for git suite was started by David Greaves\r
2060 &lt;<ulink url="mailto:david@dgreaves.com">david@dgreaves.com</ulink>&gt;, and later enhanced greatly by the\r
2061 contributors on the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
2062 </simplesect>\r
2063 <simplesect id="_see_also">\r
2064 <title>SEE ALSO</title>\r
2065 <simpara><xref linkend="gittutorial(7)"/>, <xref linkend="gittutorial-2(7)"/>,\r
2066 <ulink url="everyday.html">Everyday Git</ulink>, <xref linkend="gitcvs-migration(7)"/>,\r
2067 <xref linkend="gitglossary(7)"/>, <xref linkend="gitcore-tutorial(7)"/>,\r
2068 <xref linkend="gitcli(7)"/>, <ulink url="user-manual.html">The Git User&#8217;s Manual</ulink></simpara>\r
2069 </simplesect>\r
2070 <simplesect id="_git">\r
2071 <title>GIT</title>\r
2072 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
2073 </simplesect>\r
2074 </article>\r