diff options
| author | Junio C Hamano <gitster@pobox.com> | 2012-12-18 16:43:11 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-12-18 16:43:11 -0800 |
| commit | 9d9711544dc3090db6e5c52f9ce9c300bf4f5c14 (patch) | |
| tree | 23257b9801739fd96c9e82ef98a17500dce9f88e /gitcli.html | |
| parent | 9629d4f49e5ffcff5c5beb5c40bedcffcabcd905 (diff) | |
| download | git-htmldocs-9d9711544dc3090db6e5c52f9ce9c300bf4f5c14.tar.gz | |
Autogenerated HTML docs for v1.8.1-rc2-5-g252f9
Diffstat (limited to 'gitcli.html')
| -rw-r--r-- | gitcli.html | 502 |
1 files changed, 342 insertions, 160 deletions
diff --git a/gitcli.html b/gitcli.html index 9b26f19e9..50953cb8d 100644 --- a/gitcli.html +++ b/gitcli.html @@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.5.2" />
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.8" />
<title>gitcli(7)</title>
<style type="text/css">
-/* Debug borders */
-p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
-/*
- border: 1px solid red;
-*/
+/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
+
+/* Default font. */
+body {
+ font-family: Georgia,serif;
+}
+
+/* Title font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+#toctitle,
+#author, #revnumber, #revdate, #revremark,
+#footer {
+ font-family: Arial,Helvetica,sans-serif;
}
body {
@@ -35,13 +45,8 @@ strong { color: #083194;
}
-tt {
- color: navy;
-}
-
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
- font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
@@ -59,9 +64,11 @@ h3 { h3 + * {
clear: left;
}
+h5 {
+ font-size: 1.0em;
+}
div.sectionbody {
- font-family: serif;
margin-left: 0;
}
@@ -77,45 +84,48 @@ p { ul, ol, li > p {
margin-top: 0;
}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
-pre {
+.monospaced, code, pre {
+ font-family: "Courier New", Courier, monospace;
+ font-size: inherit;
+ color: navy;
padding: 0;
margin: 0;
}
-span#author {
+
+#author {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
-span#email {
+#email {
}
-span#revnumber, span#revdate, span#revremark {
- font-family: sans-serif;
+#revnumber, #revdate, #revremark {
}
-div#footer {
- font-family: sans-serif;
+#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
-div#footer-text {
+#footer-text {
float: left;
padding-bottom: 0.5em;
}
-div#footer-badges {
+#footer-badges {
float: right;
padding-bottom: 0.5em;
}
-div#preamble {
+#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
-div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
@@ -135,7 +145,6 @@ div.content { /* Block element content. */ /* Block element titles. */
div.title, caption.title {
color: #527bbd;
- font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
@@ -157,13 +166,15 @@ div.content + div.title { div.sidebarblock > div.content {
background: #ffffee;
- border: 1px solid silver;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
- border: 1px solid silver;
- background: #f4f4f4;
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
padding: 0.5em;
}
@@ -171,8 +182,8 @@ div.quoteblock, div.verseblock { padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
- border-left: 5px solid #dddddd;
- color: #777777;
+ border-left: 5px solid #f0f0f0;
+ color: #888;
}
div.quoteblock > div.attribution {
@@ -180,8 +191,9 @@ div.quoteblock > div.attribution { text-align: right;
}
-div.verseblock > div.content {
- white-space: pre;
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
@@ -254,35 +266,12 @@ div.compact div, div.compact div { margin-bottom: 0.1em;
}
-div.tableblock > table {
- border: 3px solid #527bbd;
-}
-thead, p.table.header {
- font-family: sans-serif;
- font-weight: bold;
-}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
-p.table {
- margin-top: 0;
-}
-/* Because the table frame attribute is overriden by CSS in most browsers. */
-div.tableblock > table[frame="void"] {
- border-style: none;
-}
-div.tableblock > table[frame="hsides"] {
- border-left-style: none;
- border-right-style: none;
-}
-div.tableblock > table[frame="vsides"] {
- border-top-style: none;
- border-bottom-style: none;
-}
-
div.hdlist {
margin-top: 0.8em;
@@ -339,25 +328,32 @@ span.footnote, span.footnoteref { min-width: 100px;
}
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
@media print {
- div#footer-badges { display: none; }
+ #footer-badges { display: none; }
}
-div#toc {
+#toc {
margin-bottom: 2.5em;
}
-div#toctitle {
+#toctitle {
color: #527bbd;
- font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
-div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
@@ -373,69 +369,173 @@ div.toclevel4 { margin-left: 6em;
font-size: 0.9em;
}
-/* Overrides for manpage documents */
-h1 {
- padding-top: 0.5em;
- padding-bottom: 0.5em;
- border-top: 2px solid silver;
- border-bottom: 2px solid silver;
+
+span.aqua { color: aqua; }
+span.black { color: black; }
+span.blue { color: blue; }
+span.fuchsia { color: fuchsia; }
+span.gray { color: gray; }
+span.green { color: green; }
+span.lime { color: lime; }
+span.maroon { color: maroon; }
+span.navy { color: navy; }
+span.olive { color: olive; }
+span.purple { color: purple; }
+span.red { color: red; }
+span.silver { color: silver; }
+span.teal { color: teal; }
+span.white { color: white; }
+span.yellow { color: yellow; }
+
+span.aqua-background { background: aqua; }
+span.black-background { background: black; }
+span.blue-background { background: blue; }
+span.fuchsia-background { background: fuchsia; }
+span.gray-background { background: gray; }
+span.green-background { background: green; }
+span.lime-background { background: lime; }
+span.maroon-background { background: maroon; }
+span.navy-background { background: navy; }
+span.olive-background { background: olive; }
+span.purple-background { background: purple; }
+span.red-background { background: red; }
+span.silver-background { background: silver; }
+span.teal-background { background: teal; }
+span.white-background { background: white; }
+span.yellow-background { background: yellow; }
+
+span.big { font-size: 2em; }
+span.small { font-size: 0.6em; }
+
+span.underline { text-decoration: underline; }
+span.overline { text-decoration: overline; }
+span.line-through { text-decoration: line-through; }
+
+div.unbreakable { page-break-inside: avoid; }
+
+
+/*
+ * xhtml11 specific
+ *
+ * */
+
+div.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
}
-h2 {
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead, p.table.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+p.table {
+ margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
border-style: none;
}
-div.sectionbody {
- margin-left: 5%;
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
}
-
-@media print {
- div#toc { display: none; }
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
}
-/* Workarounds for IE6's broken and incomplete CSS2. */
-div.sidebar-content {
- background: #ffffee;
- border: 1px solid silver;
- padding: 0.5em;
+/*
+ * html5 specific
+ *
+ * */
+
+table.tableblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
}
-div.sidebar-title, div.image-title {
- color: #527bbd;
- font-family: sans-serif;
+thead, p.tableblock.header {
font-weight: bold;
- margin-top: 0.0em;
- margin-bottom: 0.5em;
+ color: #527bbd;
+}
+p.tableblock {
+ margin-top: 0;
+}
+table.tableblock {
+ border-width: 3px;
+ border-spacing: 0px;
+ border-style: solid;
+ border-color: #527bbd;
+ border-collapse: collapse;
+}
+th.tableblock, td.tableblock {
+ border-width: 1px;
+ padding: 4px;
+ border-style: solid;
+ border-color: #527bbd;
}
-div.listingblock div.content {
- border: 1px solid silver;
- background: #f4f4f4;
- padding: 0.5em;
+table.tableblock.frame-topbot {
+ border-left-style: hidden;
+ border-right-style: hidden;
+}
+table.tableblock.frame-sides {
+ border-top-style: hidden;
+ border-bottom-style: hidden;
+}
+table.tableblock.frame-none {
+ border-style: hidden;
}
-div.quoteblock-attribution {
- padding-top: 0.5em;
+th.tableblock.halign-left, td.tableblock.halign-left {
+ text-align: left;
+}
+th.tableblock.halign-center, td.tableblock.halign-center {
+ text-align: center;
+}
+th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
-div.verseblock-content {
- white-space: pre;
+th.tableblock.valign-top, td.tableblock.valign-top {
+ vertical-align: top;
}
-div.verseblock-attribution {
- padding-top: 0.75em;
- text-align: left;
+th.tableblock.valign-middle, td.tableblock.valign-middle {
+ vertical-align: middle;
+}
+th.tableblock.valign-bottom, td.tableblock.valign-bottom {
+ vertical-align: bottom;
}
-div.exampleblock-content {
- border-left: 3px solid #dddddd;
- padding-left: 0.5em;
+
+/*
+ * manpage specific
+ *
+ * */
+
+body.manpage h1 {
+ padding-top: 0.5em;
+ padding-bottom: 0.5em;
+ border-top: 2px solid silver;
+ border-bottom: 2px solid silver;
+}
+body.manpage h2 {
+ border-style: none;
+}
+body.manpage div.sectionbody {
+ margin-left: 3em;
+}
+
+@media print {
+ body.manpage div#toc { display: none; }
}
-/* IE6 sets dynamically generated links as visited. */
-div#toc a:visited { color: blue; }
+
</style>
<script type="text/javascript">
/*<+'])');
+ var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
@@ -497,6 +597,25 @@ toc: function (toclevels) { }
var toc = document.getElementById("toc");
+ if (!toc) {
+ return;
+ }
+
+ // Delete existing TOC entries in case we're reloading the TOC.
+ var tocEntriesToRemove = [];
+ var i;
+ for (i = 0; i < toc.childNodes.length; i++) {
+ var entry = toc.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div'
+ && entry.getAttribute("class")
+ && entry.getAttribute("class").match(/^toclevel/))
+ tocEntriesToRemove.push(entry);
+ }
+ for (i = 0; i < tocEntriesToRemove.length; i++) {
+ toc.removeChild(tocEntriesToRemove[i]);
+ }
+
+ // Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
@@ -524,24 +643,44 @@ toc: function (toclevels) { */
footnotes: function () {
- var cont = document.getElementById("content");
+ // Delete existing footnote entries in case we're reloading the footnodes.
+ var i;
var noteholder = document.getElementById("footnotes");
+ if (!noteholder) {
+ return;
+ }
+ var entriesToRemove = [];
+ for (i = 0; i < noteholder.childNodes.length; i++) {
+ var entry = noteholder.childNodes[i];
+ if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
+ entriesToRemove.push(entry);
+ }
+ for (i = 0; i < entriesToRemove.length; i++) {
+ noteholder.removeChild(entriesToRemove[i]);
+ }
+
+ // Rebuild footnote entries.
+ var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
- // Use [\s\S] in place of . so multi-line matches work.
- // Because JavaScript has no s (dotall) regex flag.
- note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ var note = spans[i].getAttribute("data-note");
+ if (!note) {
+ // Use [\s\S] in place of . so multi-line matches work.
+ // Because JavaScript has no s (dotall) regex flag.
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ spans[i].innerHTML =
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ spans[i].setAttribute("data-note", note);
+ }
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
- spans[i].innerHTML =
- "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
- "' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
@@ -561,13 +700,36 @@ footnotes: function () { }
}
}
+},
+
+install: function(toclevels) {
+ var timerId;
+
+ function reinstall() {
+ asciidoc.footnotes();
+ if (toclevels) {
+ asciidoc.toc(toclevels);
+ }
+ }
+
+ function reinstallAndRemoveTimer() {
+ clearInterval(timerId);
+ reinstall();
+ }
+
+ timerId = setInterval(reinstall, 500);
+ if (document.addEventListener)
+ document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
+ else
+ window.onload = reinstallAndRemoveTimer;
}
}
+asciidoc.install();
/*]]>*/
</script>
</head>
-<body>
+<body class="manpage">
<div id="header">
<h1>
gitcli(7) Manual Page
@@ -580,10 +742,13 @@ gitcli(7) Manual Page </div>
</div>
<div id="content">
+<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph"><p>gitcli</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>This manual describes the convention used throughout git CLI.</p></div>
@@ -594,33 +759,33 @@ arguments. Here are the rules:</p></div> <li>
<p>
Revisions come first and then paths.
- E.g. in <tt>git diff v1.0 v2.0 arch/x86 include/asm-x86</tt>,
- <tt>v1.0</tt> and <tt>v2.0</tt> are revisions and <tt>arch/x86</tt> and <tt>include/asm-x86</tt>
+ E.g. in <code>git diff v1.0 v2.0 arch/x86 include/asm-x86</code>,
+ <code>v1.0</code> and <code>v2.0</code> are revisions and <code>arch/x86</code> and <code>include/asm-x86</code>
are paths.
</p>
</li>
<li>
<p>
When an argument can be misunderstood as either a revision or a path,
- they can be disambiguated by placing <tt>--</tt> between them.
- E.g. <tt>git diff -- HEAD</tt> is, "I have a file called HEAD in my work
+ they can be disambiguated by placing <code>--</code> between them.
+ E.g. <code>git diff -- HEAD</code> is, "I have a file called HEAD in my work
tree. Please show changes between the version I staged in the index
and what I have in the work tree for that file". not "show difference
between the HEAD commit and the work tree as a whole". You can say
- <tt>git diff HEAD --</tt> to ask for the latter.
+ <code>git diff HEAD --</code> to ask for the latter.
</p>
</li>
<li>
<p>
-Without disambiguating <tt>--</tt>, git makes a reasonable guess, but errors
+Without disambiguating <code>--</code>, git makes a reasonable guess, but errors
out and asking you to disambiguate when ambiguous. E.g. if you have a
- file called HEAD in your work tree, <tt>git diff HEAD</tt> is ambiguous, and
- you have to say either <tt>git diff HEAD --</tt> or <tt>git diff -- HEAD</tt> to
+ file called HEAD in your work tree, <code>git diff HEAD</code> is ambiguous, and
+ you have to say either <code>git diff HEAD --</code> or <code>git diff -- HEAD</code> to
disambiguate.
</p>
<div class="paragraph"><p>When writing a script that is expected to handle random user-input, it is
a good practice to make it explicit which arguments are which by placing
-disambiguating <tt>--</tt> at appropriate places.</p></div>
+disambiguating <code>--</code> at appropriate places.</p></div>
</li>
<li>
<p>
@@ -630,15 +795,15 @@ Many commands allow wildcards in paths, but you need to protect </p>
<div class="listingblock">
<div class="content">
-<pre><tt>$ git checkout -- *.c
-$ git checkout -- \*.c</tt></pre>
+<pre><code>$ git checkout -- *.c
+$ git checkout -- \*.c</code></pre>
</div></div>
<div class="paragraph"><p>The former lets your shell expand the fileglob, and you are asking
the dot-C files in your working tree to be overwritten with the version
-in the index. The latter passes the <tt>*.c</tt> to Git, and you are asking
+in the index. The latter passes the <code>*.c</code> to Git, and you are asking
the paths in the index that match the pattern to be checked out to your
-working tree. After running <tt>git add hello.c; rm hello.c</tt>, you will <em>not</em>
-see <tt>hello.c</tt> in your working tree with the former, but with the latter
+working tree. After running <code>git add hello.c; rm hello.c</code>, you will <em>not</em>
+see <code>hello.c</code> in your working tree with the former, but with the latter
you will.</p></div>
</li>
</ul></div>
@@ -648,20 +813,20 @@ scripting git:</p></div> <li>
<p>
it’s preferred to use the non dashed form of git commands, which means that
- you should prefer <tt>git foo</tt> to <tt>git-foo</tt>.
+ you should prefer <code>git foo</code> to <code>git-foo</code>.
</p>
</li>
<li>
<p>
-splitting short options to separate words (prefer <tt>git foo -a -b</tt>
- to <tt>git foo -ab</tt>, the latter may not even work).
+splitting short options to separate words (prefer <code>git foo -a -b</code>
+ to <code>git foo -ab</code>, the latter may not even work).
</p>
</li>
<li>
<p>
when a command line option takes an argument, use the <em>sticked</em> form. In
- other words, write <tt>git foo -oArg</tt> instead of <tt>git foo -o Arg</tt> for short
- options, and <tt>git foo --long-opt=Arg</tt> instead of <tt>git foo --long-opt Arg</tt>
+ other words, write <code>git foo -oArg</code> instead of <code>git foo -o Arg</code> for short
+ options, and <code>git foo --long-opt=Arg</code> instead of <code>git foo --long-opt Arg</code>
for long options. An option that takes optional option-argument must be
written in the <em>sticked</em> form.
</p>
@@ -670,8 +835,8 @@ when a command line option takes an argument, use the <em>sticked</em> form. In <p>
when you give a revision parameter to a command, make sure the parameter is
not ambiguous with a name of a file in the work tree. E.g. do not write
- <tt>git log -1 HEAD</tt> but write <tt>git log -1 HEAD --</tt>; the former will not work
- if you happen to have a file called <tt>HEAD</tt> in the work tree.
+ <code>git log -1 HEAD</code> but write <code>git log -1 HEAD --</code>; the former will not work
+ if you happen to have a file called <code>HEAD</code> in the work tree.
</p>
</li>
<li>
@@ -687,12 +852,15 @@ many commands allow a long option "--option" to be abbreviated </li>
</ul></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_enhanced_option_parser">ENHANCED OPTION PARSER</h2>
<div class="sectionbody">
<div class="paragraph"><p>From the git 1.5.4 series and further, many git commands (not all of them at the
time of the writing though) come with an enhanced option parser.</p></div>
<div class="paragraph"><p>Here is a list of the facilities provided by this option parser.</p></div>
-<h3 id="_magic_options">Magic Options</h3><div style="clear:left"></div>
+<div class="sect2">
+<h3 id="_magic_options">Magic Options</h3>
<div class="paragraph"><p>Commands which have the enhanced option parser activated all understand a
couple of magic command line options:</p></div>
<div class="dlist"><dl>
@@ -705,7 +873,7 @@ couple of magic command line options:</p></div> </p>
<div class="listingblock">
<div class="content">
-<pre><tt>$ git describe -h
+<pre><code>$ git describe -h
usage: git describe [options] <committish>*
--contains find the tag that comes after the commit
@@ -713,7 +881,7 @@ usage: git describe [options] <committish>* --all use any ref in .git/refs
--tags use any tag in .git/refs/tags
--abbrev [<n>] use <n> digits to display SHA-1s
- --candidates <n> consider <n> most recent tags (default: 10)</tt></pre>
+ --candidates <n> consider <n> most recent tags (default: 10)</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
@@ -727,45 +895,56 @@ usage: git describe [options] <committish>* </p>
</dd>
</dl></div>
-<h3 id="_negating_options">Negating options</h3><div style="clear:left"></div>
-<div class="paragraph"><p>Options with long option names can be negated by prefixing <tt>--no-</tt>. For
-example, <tt>git branch</tt> has the option <tt>--track</tt> which is <em>on</em> by default. You
-can use <tt>--no-track</tt> to override that behaviour. The same goes for <tt>--color</tt>
-and <tt>--no-color</tt>.</p></div>
-<h3 id="_aggregating_short_options">Aggregating short options</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_negating_options">Negating options</h3>
+<div class="paragraph"><p>Options with long option names can be negated by prefixing <code>--no-</code>. For
+example, <code>git branch</code> has the option <code>--track</code> which is <em>on</em> by default. You
+can use <code>--no-track</code> to override that behaviour. The same goes for <code>--color</code>
+and <code>--no-color</code>.</p></div>
+</div>
+<div class="sect2">
+<h3 id="_aggregating_short_options">Aggregating short options</h3>
<div class="paragraph"><p>Commands that support the enhanced option parser allow you to aggregate short
-options. This means that you can for example use <tt>git rm -rf</tt> or
-<tt>git clean -fdx</tt>.</p></div>
-<h3 id="_abbreviating_long_options">Abbreviating long options</h3><div style="clear:left"></div>
+options. This means that you can for example use <code>git rm -rf</code> or
+<code>git clean -fdx</code>.</p></div>
+</div>
+<div class="sect2">
+<h3 id="_abbreviating_long_options">Abbreviating long options</h3>
<div class="paragraph"><p>Commands that support the enhanced option parser accepts unique
prefix of a long option as if it is fully spelled out, but use this
-with a caution. For example, <tt>git commit --amen</tt> behaves as if you
-typed <tt>git commit --amend</tt>, but that is true only until a later version
+with a caution. For example, <code>git commit --amen</code> behaves as if you
+typed <code>git commit --amend</code>, but that is true only until a later version
of Git introduces another option that shares the same prefix,
e.g `git commit --amenity" option.</p></div>
-<h3 id="_separating_argument_from_the_option">Separating argument from the option</h3><div style="clear:left"></div>
+</div>
+<div class="sect2">
+<h3 id="_separating_argument_from_the_option">Separating argument from the option</h3>
<div class="paragraph"><p>You can write the mandatory option parameter to an option as a separate
word on the command line. That means that all the following uses work:</p></div>
<div class="listingblock">
<div class="content">
-<pre><tt>$ git foo --long-opt=Arg
+<pre><code>$ git foo --long-opt=Arg
$ git foo --long-opt Arg
$ git foo -oArg
-$ git foo -o Arg</tt></pre>
+$ git foo -o Arg</code></pre>
</div></div>
<div class="paragraph"><p>However, this is <strong>NOT</strong> allowed for switches with an optional value, where the
<em>sticked</em> form must be used:</p></div>
<div class="listingblock">
<div class="content">
-<pre><tt>$ git describe --abbrev HEAD # correct
+<pre><code>$ git describe --abbrev HEAD # correct
$ git describe --abbrev=10 HEAD # correct
-$ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT</tt></pre>
+$ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT</code></pre>
</div></div>
</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="_notes_on_frequently_confused_options">NOTES ON FREQUENTLY CONFUSED OPTIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Many commands that can work on files in the working tree
-and/or in the index can take <tt>--cached</tt> and/or <tt>--index</tt>
+and/or in the index can take <code>--cached</code> and/or <code>--index</code>
options. Sometimes people incorrectly think that, because
the index was originally called cache, these two are
synonyms. They are <strong>not</strong> — these two options mean very
@@ -773,41 +952,44 @@ different things.</p></div> <div class="ulist"><ul>
<li>
<p>
-The <tt>--cached</tt> option is used to ask a command that
+The <code>--cached</code> option is used to ask a command that
usually works on files in the working tree to <strong>only</strong> work
- with the index. For example, <tt>git grep</tt>, when used
+ with the index. For example, <code>git grep</code>, when used
without a commit to specify from which commit to look for
strings in, usually works on files in the working tree,
- but with the <tt>--cached</tt> option, it looks for strings in
+ but with the <code>--cached</code> option, it looks for strings in
the index.
</p>
</li>
<li>
<p>
-The <tt>--index</tt> option is used to ask a command that
+The <code>--index</code> option is used to ask a command that
usually works on files in the working tree to <strong>also</strong>
- affect the index. For example, <tt>git stash apply</tt> usually
+ affect the index. For example, <code>git stash apply</code> usually
merges changes recorded in a stash to the working tree,
- but with the <tt>--index</tt> option, it also merges changes to
+ but with the <code>--index</code> option, it also merges changes to
the index as well.
</p>
</li>
</ul></div>
-<div class="paragraph"><p><tt>git apply</tt> command can be used with <tt>--cached</tt> and
-<tt>--index</tt> (but not at the same time). Usually the command
+<div class="paragraph"><p><code>git apply</code> command can be used with <code>--cached</code> and
+<code>--index</code> (but not at the same time). Usually the command
only affects the files in the working tree, but with
-<tt>--index</tt>, it patches both the files and their index
-entries, and with <tt>--cached</tt>, it modifies only the index
+<code>--index</code>, it patches both the files and their index
+entries, and with <code>--cached</code>, it modifies only the index
entries.</p></div>
<div class="paragraph"><p>See also <a href="http://marc.info/?l=git&m=116563135620359">http://marc.info/?l=git&m=116563135620359</a> and
<a href="http://marc.info/?l=git&m=119150393620273">http://marc.info/?l=git&m=119150393620273</a> for further
information.</p></div>
</div>
+</div>
+<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
</div>
+</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
|