Google Git
Sign in
chromium / external / gitster / git-htmldocs / c28068f42827f92c7c73c184e4fd11ceba0c73da / . / gitcli.html
blob: ef4df2b8aa2be843dc0ca72ce5abc0264c0f6e74 [file] [log] [blame]
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]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">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]47h1, h2, h3 {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]83 font-size: 1.1em;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]164
165div.attribution {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]166 text-align: right;
167}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]214div.olist2 ol {
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]306</style>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]307<title>gitcli(7)</title>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]308</head>
309<body>
310<div id="header">
311<h1>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]312gitcli(7) Manual Page
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>gitcli -
317 git command line interface and conventions
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]323<div class="para"><p>gitcli</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]324</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]326<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]327<div class="para"><p>This manual describes the convention used throughout git CLI.</p></div>
328<div class="para"><p>Many commands take revisions (most often "commits", but sometimes
Junio C Hamanoc4fec202008-06-28 10:07:24[diff] [blame]329"tree-ish", depending on the context and command) and paths as their
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]330arguments. Here are the rules:</p></div>
331<div class="ilist"><ul>
Junio C Hamanoc4fec202008-06-28 10:07:24[diff] [blame]332<li>
333<p>
334Revisions come first and then paths.
335 E.g. in <tt>git diff v1.0 v2.0 arch/x86 include/asm-x86</tt>,
336 <tt>v1.0</tt> and <tt>v2.0</tt> are revisions and <tt>arch/x86</tt> and <tt>include/asm-x86</tt>
337 are paths.
338</p>
339</li>
340<li>
341<p>
342When an argument can be misunderstood as either a revision or a path,
343 they can be disambiguated by placing <tt>--</tt> between them.
344 E.g. <tt>git diff -- HEAD</tt> is, "I have a file called HEAD in my work
345 tree. Please show changes between the version I staged in the index
346 and what I have in the work tree for that file". not "show difference
347 between the HEAD commit and the work tree as a whole". You can say
348 <tt>git diff HEAD --</tt> to ask for the latter.
349</p>
350</li>
351<li>
352<p>
353Without disambiguating <tt>--</tt>, git makes a reasonable guess, but errors
354 out and asking you to disambiguate when ambiguous. E.g. if you have a
355 file called HEAD in your work tree, <tt>git diff HEAD</tt> is ambiguous, and
356 you have to say either <tt>git diff HEAD --</tt> or <tt>git diff -- HEAD</tt> to
357 disambiguate.
358</p>
359</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]360</ul></div>
361<div class="para"><p>When writing a script that is expected to handle random user-input, it is
Junio C Hamanoc4fec202008-06-28 10:07:24[diff] [blame]362a good practice to make it explicit which arguments are which by placing
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]363disambiguating <tt>--</tt> at appropriate places.</p></div>
364<div class="para"><p>Here are the rules regarding the "flags" that you should follow when you are
365scripting git:</p></div>
366<div class="ilist"><ul>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]367<li>
368<p>
369it's preferred to use the non dashed form of git commands, which means that
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]370 you should prefer <tt>git foo</tt> to <tt>git-foo</tt>.
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]371</p>
372</li>
373<li>
374<p>
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]375splitting short options to separate words (prefer <tt>git foo -a -b</tt>
376 to <tt>git foo -ab</tt>, the latter may not even work).
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]377</p>
378</li>
379<li>
380<p>
381when a command line option takes an argument, use the <em>sticked</em> form. In
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]382 other words, write <tt>git foo -oArg</tt> instead of <tt>git foo -o Arg</tt> for short
383 options, and <tt>git foo --long-opt=Arg</tt> instead of <tt>git foo --long-opt Arg</tt>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]384 for long options. An option that takes optional option-argument must be
385 written in the <em>sticked</em> form.
386</p>
387</li>
388<li>
389<p>
390when you give a revision parameter to a command, make sure the parameter is
391 not ambiguous with a name of a file in the work tree. E.g. do not write
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]392 <tt>git log -1 HEAD</tt> but write <tt>git log -1 HEAD --</tt>; the former will not work
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]393 if you happen to have a file called <tt>HEAD</tt> in the work tree.
394</p>
395</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]396</ul></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]397</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]398<h2 id="_enhanced_option_parser">ENHANCED OPTION PARSER</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]399<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]400<div class="para"><p>From the git 1.5.4 series and further, many git commands (not all of them at the
401time of the writing though) come with an enhanced option parser.</p></div>
402<div class="para"><p>Here is an exhaustive list of the facilities provided by this option parser.</p></div>
403<h3 id="_magic_options">Magic Options</h3><div style="clear:left"></div>
404<div class="para"><p>Commands which have the enhanced option parser activated all understand a
405couple of magic command line options:</p></div>
406<div class="vlist"><dl>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]407<dt>
408-h
409</dt>
410<dd>
411<p>
412 gives a pretty printed usage of the command.
413</p>
414<div class="listingblock">
415<div class="content">
416<pre><tt>$ git describe -h
417usage: git-describe [options] &lt;committish&gt;*
418
419 --contains find the tag that comes after the commit
420 --debug debug search strategy on stderr
421 --all use any ref in .git/refs
422 --tags use any tag in .git/refs/tags
423 --abbrev [&lt;n&gt;] use &lt;n&gt; digits to display SHA-1s
424 --candidates &lt;n&gt; consider &lt;n&gt; most recent tags (default: 10)</tt></pre>
425</div></div>
426</dd>
427<dt>
428--help-all
429</dt>
430<dd>
431<p>
432 Some git commands take options that are only used for plumbing or that
433 are deprecated, and such options are hidden from the default usage. This
434 option gives the full list of options.
435</p>
436</dd>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]437</dl></div>
438<h3 id="_negating_options">Negating options</h3><div style="clear:left"></div>
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]439<div class="para"><p>Options with long option names can be negated by prefixing <tt>--no-</tt>. For
440example, <tt>git branch</tt> has the option <tt>--track</tt> which is <em>on</em> by default. You
441can use <tt>--no-track</tt> to override that behaviour. The same goes for <tt>--color</tt>
442and <tt>--no-color</tt>.</p></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]443<h3 id="_aggregating_short_options">Aggregating short options</h3><div style="clear:left"></div>
444<div class="para"><p>Commands that support the enhanced option parser allow you to aggregate short
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]445options. This means that you can for example use <tt>git rm -rf</tt> or
446<tt>git clean -fdx</tt>.</p></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]447<h3 id="_separating_argument_from_the_option">Separating argument from the option</h3><div style="clear:left"></div>
448<div class="para"><p>You can write the mandatory option parameter to an option as a separate
449word on the command line. That means that all the following uses work:</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]450<div class="listingblock">
451<div class="content">
452<pre><tt>$ git foo --long-opt=Arg
453$ git foo --long-opt Arg
454$ git foo -oArg
455$ git foo -o Arg</tt></pre>
456</div></div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]457<div class="para"><p>However, this is <strong>NOT</strong> allowed for switches with an optional value, where the
458<em>sticked</em> form must be used:</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]459<div class="listingblock">
460<div class="content">
461<pre><tt>$ git describe --abbrev HEAD # correct
462$ git describe --abbrev=10 HEAD # correct
463$ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT</tt></pre>
464</div></div>
465</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]466<h2 id="_notes_on_frequently_confused_options">NOTES ON FREQUENTLY CONFUSED OPTIONS</h2>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]467<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]468<div class="para"><p>Many commands that can work on files in the working tree
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]469and/or in the index can take <tt>--cached</tt> and/or <tt>--index</tt>
470options. Sometimes people incorrectly think that, because
471the index was originally called cache, these two are
472synonyms. They are <strong>not</strong> &#8212; these two options mean very
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]473different things.</p></div>
474<div class="ilist"><ul>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]475<li>
476<p>
477The <tt>--cached</tt> option is used to ask a command that
478 usually works on files in the working tree to <strong>only</strong> work
479 with the index. For example, <tt>git grep</tt>, when used
480 without a commit to specify from which commit to look for
481 strings in, usually works on files in the working tree,
482 but with the <tt>--cached</tt> option, it looks for strings in
483 the index.
484</p>
485</li>
486<li>
487<p>
488The <tt>--index</tt> option is used to ask a command that
489 usually works on files in the working tree to <strong>also</strong>
490 affect the index. For example, <tt>git stash apply</tt> usually
491 merges changes recorded in a stash to the working tree,
492 but with the <tt>--index</tt> option, it also merges changes to
493 the index as well.
494</p>
495</li>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]496</ul></div>
497<div class="para"><p><tt>git apply</tt> command can be used with <tt>--cached</tt> and
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]498<tt>--index</tt> (but not at the same time). Usually the command
499only affects the files in the working tree, but with
500<tt>--index</tt>, it patches both the files and their index
501entries, and with <tt>--cached</tt>, it modifies only the index
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]502entries.</p></div>
503<div class="para"><p>See also http://marc.info/?l=git&amp;m=116563135620359 and
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]504http://marc.info/?l=git&amp;m=119150393620273 for further
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]505information.</p></div>
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]506</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]507<h2 id="_documentation">Documentation</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]508<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]509<div class="para"><p>Documentation by Pierre Habouzit and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]510</div>
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]511<h2 id="_git">GIT</h2>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]512<div class="sectionbody">
Junio C Hamano4604fe52008-09-19 06:37:10[diff] [blame]513<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]514</div>
515<div id="footer">
516<div id="footer-text">
Junio C Hamano73d812c2009-07-01 02:33:06[diff] [blame]517Last updated 2009-07-01 02:31:09 UTC
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]518</div>
519</div>
520</body>
521</html>