diff options
| author | Junio C Hamano <junio@hera.kernel.org> | 2007-12-23 08:16:38 +0000 |
|---|---|---|
| committer | Junio C Hamano <junio@hera.kernel.org> | 2007-12-23 08:16:38 +0000 |
| commit | f556fc2a7c28ca2b4097c2c8b0180de3b8ca7238 (patch) | |
| tree | 492751e5dfadd3be5f438844968502b050c72c54 /gitcli.html | |
| parent | e27cbd23f20512f381606e2b437bfe80c681aa93 (diff) | |
| download | git-htmldocs-f556fc2a7c28ca2b4097c2c8b0180de3b8ca7238.tar.gz | |
Autogenerated HTML docs for v1.5.4-rc1-21-g0e545
Diffstat (limited to 'gitcli.html')
| -rw-r--r-- | gitcli.html | 395 |
1 files changed, 395 insertions, 0 deletions
diff --git a/gitcli.html b/gitcli.html new file mode 100644 index 000000000..0a6bad1c1 --- /dev/null +++ b/gitcli.html @@ -0,0 +1,395 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "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 7.0.2" />
+<style type="text/css">
+/* Debug borders */
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
+/*
+ border: 1px solid red;
+*/
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a { color: blue; }
+a:visited { color: fuchsia; }
+
+em {
+ font-style: italic;
+}
+
+strong {
+ font-weight: bold;
+}
+
+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;
+}
+
+h1 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ border-bottom: 2px solid silver;
+ padding-top: 0.5em;
+}
+
+div.sectionbody {
+ font-family: serif;
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+pre {
+ padding: 0;
+ margin: 0;
+}
+
+span#author {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+span#email {
+}
+span#revision {
+ font-family: sans-serif;
+}
+
+div#footer {
+ font-family: sans-serif;
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+div#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+div#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+div#preamble,
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-right: 10%;
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.5em;
+ margin-bottom: 2.5em;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ font-family: sans-serif;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock > div.content {
+ padding-left: 2.0em;
+}
+div.quoteblock .attribution {
+ text-align: right;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 2px solid silver;
+}
+
+div.exampleblock > div.content {
+ border-left: 2px solid silver;
+ padding: 0.5em;
+}
+
+div.verseblock div.content {
+ white-space: pre;
+}
+
+div.imageblock div.content { padding-left: 0; }
+div.imageblock img { border: 1px solid silver; }
+span.image img { border-style: none; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: italic;
+}
+dd > *:first-child {
+ margin-top: 0;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.olist2 {
+ list-style-type: lower-alpha;
+}
+
+div.tableblock > table {
+ border-color: #527bbd;
+ border-width: 3px;
+}
+thead {
+ font-family: sans-serif;
+ font-weight: bold;
+}
+tfoot {
+ font-weight: bold;
+}
+
+div.hlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+td.hlist1 {
+ vertical-align: top;
+ font-style: italic;
+ padding-right: 0.8em;
+}
+td.hlist2 {
+ vertical-align: top;
+}
+
+@media print {
+ div#footer-badges { display: none; }
+}
+include::./stylesheets/xhtml11-manpage.css[]
+/* Workarounds for IE6's broken and incomplete CSS2. */
+
+div.sidebar-content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+div.sidebar-title, div.image-title {
+ font-family: sans-serif;
+ font-weight: bold;
+ margin-top: 0.0em;
+ margin-bottom: 0.5em;
+}
+
+div.listingblock div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock-content {
+ padding-left: 2.0em;
+}
+
+div.exampleblock-content {
+ border-left: 2px solid silver;
+ padding-left: 0.5em;
+}
+</style>
+<title>gitcli(5)</title>
+</head>
+<body>
+<div id="header">
+<h1>
+gitcli(5) Manual Page
+</h1>
+<h2>NAME</h2>
+<div class="sectionbody">
+<p>gitcli -
+ git command line interface and conventions
+</p>
+</div>
+</div>
+<h2>SYNOPSIS</h2>
+<div class="sectionbody">
+<p>gitcli</p>
+</div>
+<h2>DESCRIPTION</h2>
+<div class="sectionbody">
+<p>This manual describes best practice in how to use git CLI. Here are
+the rules that you should follow when you are scripting git:</p>
+<ul>
+<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>.
+</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).
+</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>
+ for long options. An option that takes optional option-argument must be
+ written in the <em>sticked</em> form.
+</p>
+</li>
+<li>
+<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.
+</p>
+</li>
+</ul>
+</div>
+<h2>ENHANCED CLI</h2>
+<div class="sectionbody">
+<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>
+<p>Here is an exhaustive list of the facilities provided by this option parser.</p>
+<h3>Magic Options</h3>
+<p>Commands which have the enhanced option parser activated all understand a
+couple of magic command line options:</p>
+<dl>
+<dt>
+-h
+</dt>
+<dd>
+<p>
+ gives a pretty printed usage of the command.
+</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>$ git describe -h
+usage: git-describe [options] <committish>*
+
+ --contains find the tag that comes after the commit
+ --debug debug search strategy on stderr
+ --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>
+</div></div>
+</dd>
+<dt>
+--help-all
+</dt>
+<dd>
+<p>
+ Some git commands take options that are only used for plumbing or that
+ are deprecated, and such options are hidden from the default usage. This
+ option gives the full list of options.
+</p>
+</dd>
+</dl>
+<h3>Negating options</h3>
+<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>
+<h3>Aggregating short options</h3>
+<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>
+<h3>Separating argument from the option</h3>
+<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 class="listingblock">
+<div class="content">
+<pre><tt>$ git foo --long-opt=Arg
+$ git foo --long-opt Arg
+$ git foo -oArg
+$ git foo -o Arg</tt></pre>
+</div></div>
+<p>However, this is <strong>NOT</strong> allowed for switches with an optionnal value, where the
+<em>sticked</em> form must be used:</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt>$ git describe --abbrev HEAD # correct
+$ git describe --abbrev=10 HEAD # correct
+$ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT</tt></pre>
+</div></div>
+</div>
+<h2>Documentation</h2>
+<div class="sectionbody">
+<p>Documentation by Pierre Habouzit.</p>
+</div>
+<h2>GIT</h2>
+<div class="sectionbody">
+<p>Part of the <a href="git.html">git(7)</a> suite</p>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 23-Dec-2007 08:15:28 UTC
+</div>
+</div>
+</body>
+</html>
|