1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.5.2" />
7 <title>gitcli(
7)
</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
247 list-style-type: upper-roman
;
250 div
.compact ul
, div
.compact ol
,
251 div
.compact p
, div
.compact p
,
252 div
.compact div
, div
.compact div
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
277 div
.tableblock
> table
[frame
="hsides"] {
278 border-left-style: none
;
279 border-right-style: none
;
281 div
.tableblock
> table
[frame
="vsides"] {
282 border-top-style: none
;
283 border-bottom-style: none
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Overrides for manpage documents */
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver
;
381 border-bottom: 2px solid silver
;
391 div#toc
{ display: none
; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div
.sidebar-content
{
398 border: 1px solid silver
;
401 div
.sidebar-title
, div
.image-title
{
403 font-family: sans-serif
;
406 margin-bottom: 0.5em;
409 div
.listingblock div
.content
{
410 border: 1px solid silver
;
415 div
.quoteblock-attribution
{
420 div
.verseblock-content
{
423 div
.verseblock-attribution
{
428 div
.exampleblock-content
{
429 border-left: 3px solid
#dddddd;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc
a:visited
{ color: blue
; }
436 <script type=
"text/javascript">
438 window
.onload = function(){asciidoc
.footnotes();}
439 var asciidoc
= { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
459 toc: function (toclevels
) {
461 function getText(el
) {
463 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
464 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
466 else if (i
.firstChild
!= null)
472 function TocEntry(el
, text
, toclevel
) {
475 this.toclevel
= toclevel
;
478 function tocEntries(el
, toclevels
) {
479 var result
= new Array
;
480 var re
= new RegExp('[hH]([2-'+(toclevels
+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
484 var iterate = function (el
) {
485 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
486 if (i
.nodeType
== 1 /* Node.ELEMENT_NODE */) {
487 var mo
= re
.exec(i
.tagName
);
488 if (mo
&& (i
.getAttribute("class") || i
.getAttribute("className")) != "float") {
489 result
[result
.length
] = new TocEntry(i
, getText(i
), mo
[1]-1);
499 var toc
= document
.getElementById("toc");
500 var entries
= tocEntries(document
.getElementById("content"), toclevels
);
501 for (var i
= 0; i
< entries
.length
; ++i
) {
502 var entry
= entries
[i
];
503 if (entry
.element
.id
== "")
504 entry
.element
.id
= "_toc_" + i
;
505 var a
= document
.createElement("a");
506 a
.href
= "#" + entry
.element
.id
;
507 a
.appendChild(document
.createTextNode(entry
.text
));
508 var div
= document
.createElement("div");
510 div
.className
= "toclevel" + entry
.toclevel
;
511 toc
.appendChild(div
);
513 if (entries
.length
== 0)
514 toc
.parentNode
.removeChild(toc
);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont
= document
.getElementById("content");
528 var noteholder
= document
.getElementById("footnotes");
529 var spans
= cont
.getElementsByTagName("span");
532 for (i
=0; i
<spans
.length
; i
++) {
533 if (spans
[i
].className
== "footnote") {
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note
= spans
[i
].innerHTML
.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder
.innerHTML
+=
539 "<div class='footnote' id='_footnote_" + n
+ "'>" +
540 "<a href='#_footnoteref_" + n
+ "' title='Return to text'>" +
541 n
+ "</a>. " + note
+ "</div>";
543 "[<a id='_footnoteref_" + n
+ "' href='#_footnote_" + n
+
544 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
545 var id
=spans
[i
].getAttribute("id");
546 if (id
!= null) refs
["#"+id
] = n
;
550 noteholder
.parentNode
.removeChild(noteholder
);
552 // Process footnoterefs.
553 for (i
=0; i
<spans
.length
; i
++) {
554 if (spans
[i
].className
== "footnoteref") {
555 var href
= spans
[i
].getElementsByTagName("a")[0].getAttribute("href");
556 href
= href
.match(/#.*/)[0]; // Because IE return full URL.
559 "[<a href='#_footnote_" + n
+
560 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
573 gitcli(
7) Manual Page
576 <div class=
"sectionbody">
578 git command line interface and conventions
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"paragraph"><p>gitcli
</p></div>
587 <h2 id=
"_description">DESCRIPTION
</h2>
588 <div class=
"sectionbody">
589 <div class=
"paragraph"><p>This manual describes the convention used throughout git CLI.
</p></div>
590 <div class=
"paragraph"><p>Many commands take revisions (most often
"commits", but sometimes
591 "tree-ish", depending on the context and command) and paths as their
592 arguments. Here are the rules:
</p></div>
593 <div class=
"ulist"><ul>
596 Revisions come first and then paths.
597 E.g. in
<tt>git diff v1.0 v2.0 arch/x86 include/asm-x86
</tt>,
598 <tt>v1.0
</tt> and
<tt>v2.0
</tt> are revisions and
<tt>arch/x86
</tt> and
<tt>include/asm-x86
</tt>
604 When an argument can be misunderstood as either a revision or a path,
605 they can be disambiguated by placing
<tt>--
</tt> between them.
606 E.g.
<tt>git diff -- HEAD
</tt> is,
"I have a file called HEAD in my work
607 tree. Please show changes between the version I staged in the index
608 and what I have in the work tree for that file". not
"show difference
609 between the HEAD commit and the work tree as a whole". You can say
610 <tt>git diff HEAD --
</tt> to ask for the latter.
615 Without disambiguating
<tt>--
</tt>, git makes a reasonable guess, but errors
616 out and asking you to disambiguate when ambiguous. E.g. if you have a
617 file called HEAD in your work tree,
<tt>git diff HEAD
</tt> is ambiguous, and
618 you have to say either
<tt>git diff HEAD --
</tt> or
<tt>git diff -- HEAD
</tt> to
623 <div class=
"paragraph"><p>When writing a script that is expected to handle random user-input, it is
624 a good practice to make it explicit which arguments are which by placing
625 disambiguating
<tt>--
</tt> at appropriate places.
</p></div>
626 <div class=
"paragraph"><p>Here are the rules regarding the
"flags" that you should follow when you are
627 scripting git:
</p></div>
628 <div class=
"ulist"><ul>
631 it
’s preferred to use the non dashed form of git commands, which means that
632 you should prefer
<tt>git foo
</tt> to
<tt>git-foo
</tt>.
637 splitting short options to separate words (prefer
<tt>git foo -a -b
</tt>
638 to
<tt>git foo -ab
</tt>, the latter may not even work).
643 when a command line option takes an argument, use the
<em>sticked
</em> form. In
644 other words, write
<tt>git foo -oArg
</tt> instead of
<tt>git foo -o Arg
</tt> for short
645 options, and
<tt>git foo --long-opt=Arg
</tt> instead of
<tt>git foo --long-opt Arg
</tt>
646 for long options. An option that takes optional option-argument must be
647 written in the
<em>sticked
</em> form.
652 when you give a revision parameter to a command, make sure the parameter is
653 not ambiguous with a name of a file in the work tree. E.g. do not write
654 <tt>git log -
1 HEAD
</tt> but write
<tt>git log -
1 HEAD --
</tt>; the former will not work
655 if you happen to have a file called
<tt>HEAD
</tt> in the work tree.
660 <h2 id=
"_enhanced_option_parser">ENHANCED OPTION PARSER
</h2>
661 <div class=
"sectionbody">
662 <div class=
"paragraph"><p>From the git
1.5.4 series and further, many git commands (not all of them at the
663 time of the writing though) come with an enhanced option parser.
</p></div>
664 <div class=
"paragraph"><p>Here is an exhaustive list of the facilities provided by this option parser.
</p></div>
665 <h3 id=
"_magic_options">Magic Options
</h3><div style=
"clear:left"></div>
666 <div class=
"paragraph"><p>Commands which have the enhanced option parser activated all understand a
667 couple of magic command line options:
</p></div>
668 <div class=
"dlist"><dl>
674 gives a pretty printed usage of the command.
676 <div class=
"listingblock">
677 <div class=
"content">
678 <pre><tt>$ git describe -h
679 usage: git describe [options]
<committish
>*
681 --contains find the tag that comes after the commit
682 --debug debug search strategy on stderr
683 --all use any ref in .git/refs
684 --tags use any tag in .git/refs/tags
685 --abbrev [
<n
>] use
<n
> digits to display SHA-
1s
686 --candidates
<n
> consider
<n
> most recent tags (default:
10)
</tt></pre>
694 Some git commands take options that are only used for plumbing or that
695 are deprecated, and such options are hidden from the default usage. This
696 option gives the full list of options.
700 <h3 id=
"_negating_options">Negating options
</h3><div style=
"clear:left"></div>
701 <div class=
"paragraph"><p>Options with long option names can be negated by prefixing
<tt>--no-
</tt>. For
702 example,
<tt>git branch
</tt> has the option
<tt>--track
</tt> which is
<em>on
</em> by default. You
703 can use
<tt>--no-track
</tt> to override that behaviour. The same goes for
<tt>--color
</tt>
704 and
<tt>--no-color
</tt>.
</p></div>
705 <h3 id=
"_aggregating_short_options">Aggregating short options
</h3><div style=
"clear:left"></div>
706 <div class=
"paragraph"><p>Commands that support the enhanced option parser allow you to aggregate short
707 options. This means that you can for example use
<tt>git rm -rf
</tt> or
708 <tt>git clean -fdx
</tt>.
</p></div>
709 <h3 id=
"_separating_argument_from_the_option">Separating argument from the option
</h3><div style=
"clear:left"></div>
710 <div class=
"paragraph"><p>You can write the mandatory option parameter to an option as a separate
711 word on the command line. That means that all the following uses work:
</p></div>
712 <div class=
"listingblock">
713 <div class=
"content">
714 <pre><tt>$ git foo --long-opt=Arg
715 $ git foo --long-opt Arg
717 $ git foo -o Arg
</tt></pre>
719 <div class=
"paragraph"><p>However, this is
<strong>NOT
</strong> allowed for switches with an optional value, where the
720 <em>sticked
</em> form must be used:
</p></div>
721 <div class=
"listingblock">
722 <div class=
"content">
723 <pre><tt>$ git describe --abbrev HEAD # correct
724 $ git describe --abbrev=
10 HEAD # correct
725 $ git describe --abbrev
10 HEAD # NOT WHAT YOU MEANT
</tt></pre>
728 <h2 id=
"_notes_on_frequently_confused_options">NOTES ON FREQUENTLY CONFUSED OPTIONS
</h2>
729 <div class=
"sectionbody">
730 <div class=
"paragraph"><p>Many commands that can work on files in the working tree
731 and/or in the index can take
<tt>--cached
</tt> and/or
<tt>--index
</tt>
732 options. Sometimes people incorrectly think that, because
733 the index was originally called cache, these two are
734 synonyms. They are
<strong>not
</strong> — these two options mean very
735 different things.
</p></div>
736 <div class=
"ulist"><ul>
739 The
<tt>--cached
</tt> option is used to ask a command that
740 usually works on files in the working tree to
<strong>only
</strong> work
741 with the index. For example,
<tt>git grep
</tt>, when used
742 without a commit to specify from which commit to look for
743 strings in, usually works on files in the working tree,
744 but with the
<tt>--cached
</tt> option, it looks for strings in
750 The
<tt>--index
</tt> option is used to ask a command that
751 usually works on files in the working tree to
<strong>also
</strong>
752 affect the index. For example,
<tt>git stash apply
</tt> usually
753 merges changes recorded in a stash to the working tree,
754 but with the
<tt>--index
</tt> option, it also merges changes to
759 <div class=
"paragraph"><p><tt>git apply
</tt> command can be used with
<tt>--cached
</tt> and
760 <tt>--index
</tt> (but not at the same time). Usually the command
761 only affects the files in the working tree, but with
762 <tt>--index
</tt>, it patches both the files and their index
763 entries, and with
<tt>--cached
</tt>, it modifies only the index
765 <div class=
"paragraph"><p>See also
<a href=
"http://marc.info/?l=git&m=116563135620359">http://marc.info/?l=git
&m=
116563135620359</a> and
766 <a href=
"http://marc.info/?l=git&m=119150393620273">http://marc.info/?l=git
&m=
119150393620273</a> for further
767 information.
</p></div>
769 <h2 id=
"_git">GIT
</h2>
770 <div class=
"sectionbody">
771 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
774 <div id=
"footnotes"><hr /></div>
776 <div id=
"footer-text">
777 Last updated
2011-
09-
21 23:
01:
14 PDT