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>git-help(
1)
</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 git-help(
1) Manual Page
576 <div class=
"sectionbody">
578 display help information about git
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"verseblock">
586 <div class=
"verseblock-content"><em>git help
</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]
</div>
587 <div class=
"verseblock-attribution">
590 <h2 id=
"_description">DESCRIPTION
</h2>
591 <div class=
"sectionbody">
592 <div class=
"paragraph"><p>With no options and no COMMAND given, the synopsis of the
<em>git
</em>
593 command and a list of the most commonly used git commands are printed
594 on the standard output.
</p></div>
595 <div class=
"paragraph"><p>If the option
<em>--all
</em> or
<em>-a
</em> is given, then all available commands are
596 printed on the standard output.
</p></div>
597 <div class=
"paragraph"><p>If a git command is named, a manual page for that command is brought
598 up. The
<em>man
</em> program is used by default for this purpose, but this
599 can be overridden by other options or configuration variables.
</p></div>
600 <div class=
"paragraph"><p>Note that
<tt>git --help
…</tt> is identical to
<tt>git help
…</tt> because the
601 former is internally converted into the latter.
</p></div>
603 <h2 id=
"_options">OPTIONS
</h2>
604 <div class=
"sectionbody">
605 <div class=
"dlist"><dl>
614 Prints all the available commands on the standard output. This
615 option supersedes any other option.
626 Display manual page for the command in the
<em>info
</em> format. The
627 <em>info
</em> program will be used for that purpose.
638 Display manual page for the command in the
<em>man
</em> format. This
639 option may be used to override a value set in the
640 <em>help.format
</em> configuration variable.
642 <div class=
"paragraph"><p>By default the
<em>man
</em> program will be used to display the manual page,
643 but the
<em>man.viewer
</em> configuration variable may be used to choose
644 other display programs (see below).
</p></div>
654 Display manual page for the command in the
<em>web
</em> (HTML)
655 format. A web browser will be used for that purpose.
657 <div class=
"paragraph"><p>The web browser can be specified using the configuration variable
658 <em>help.browser
</em>, or
<em>web.browser
</em> if the former is not set. If none of
659 these config variables is set, the
<em>git web
--browse
</em> helper script
660 (called by
<em>git help
</em>) will pick a suitable default. See
661 <a href=
"git-web--browse.html">git-web
--browse(
1)
</a> for more information about this.
</p></div>
665 <h2 id=
"_configuration_variables">CONFIGURATION VARIABLES
</h2>
666 <div class=
"sectionbody">
667 <h3 id=
"_help_format">help.format
</h3><div style=
"clear:left"></div>
668 <div class=
"paragraph"><p>If no command line option is passed, the
<em>help.format
</em> configuration
669 variable will be checked. The following values are supported for this
670 variable; they make
<em>git help
</em> behave as their corresponding command
671 line option:
</p></div>
672 <div class=
"ulist"><ul>
675 "man" corresponds to
<em>-m|--man
</em>,
680 "info" corresponds to
<em>-i|--info
</em>,
685 "web" or
"html" correspond to
<em>-w|--web
</em>.
689 <h3 id=
"_help_browser_web_browser_and_browser_lt_tool_gt_path">help.browser, web.browser and browser.
<tool
>.path
</h3><div style=
"clear:left"></div>
690 <div class=
"paragraph"><p>The
<em>help.browser
</em>,
<em>web.browser
</em> and
<em>browser.
<tool
>.path
</em> will also
691 be checked if the
<em>web
</em> format is chosen (either by command line
692 option or configuration variable). See
<em>-w|--web
</em> in the OPTIONS
693 section above and
<a href=
"git-web--browse.html">git-web
--browse(
1)
</a>.
</p></div>
694 <h3 id=
"_man_viewer">man.viewer
</h3><div style=
"clear:left"></div>
695 <div class=
"paragraph"><p>The
<em>man.viewer
</em> config variable will be checked if the
<em>man
</em> format
696 is chosen. The following values are currently supported:
</p></div>
697 <div class=
"ulist"><ul>
700 "man": use the
<em>man
</em> program as usual,
705 "woman": use
<em>emacsclient
</em> to launch the
"woman" mode in emacs
706 (this only works starting with emacsclient versions
22),
711 "konqueror": use
<em>kfmclient
</em> to open the man page in a new konqueror
712 tab (see
<em>Note about konqueror
</em> below).
716 <div class=
"paragraph"><p>Values for other tools can be used if there is a corresponding
717 <em>man.
<tool
>.cmd
</em> configuration entry (see below).
</p></div>
718 <div class=
"paragraph"><p>Multiple values may be given to the
<em>man.viewer
</em> configuration
719 variable. Their corresponding programs will be tried in the order
720 listed in the configuration file.
</p></div>
721 <div class=
"paragraph"><p>For example, this configuration:
</p></div>
722 <div class=
"listingblock">
723 <div class=
"content">
726 viewer = woman
</tt></pre>
728 <div class=
"paragraph"><p>will try to use konqueror first. But this may fail (for example if
729 DISPLAY is not set) and in that case emacs' woman mode will be tried.
</p></div>
730 <div class=
"paragraph"><p>If everything fails, or if no viewer is configured, the viewer specified
731 in the GIT_MAN_VIEWER environment variable will be tried. If that
732 fails too, the
<em>man
</em> program will be tried anyway.
</p></div>
733 <h3 id=
"_man_lt_tool_gt_path">man.
<tool
>.path
</h3><div style=
"clear:left"></div>
734 <div class=
"paragraph"><p>You can explicitly provide a full path to your preferred man viewer by
735 setting the configuration variable
<em>man.
<tool
>.path
</em>. For example, you
736 can configure the absolute path to konqueror by setting
737 <em>man.konqueror.path
</em>. Otherwise,
<em>git help
</em> assumes the tool is
738 available in PATH.
</p></div>
739 <h3 id=
"_man_lt_tool_gt_cmd">man.
<tool
>.cmd
</h3><div style=
"clear:left"></div>
740 <div class=
"paragraph"><p>When the man viewer, specified by the
<em>man.viewer
</em> configuration
741 variables, is not among the supported ones, then the corresponding
742 <em>man.
<tool
>.cmd
</em> configuration variable will be looked up. If this
743 variable exists then the specified tool will be treated as a custom
744 command and a shell eval will be used to run the command with the man
745 page passed as arguments.
</p></div>
746 <h3 id=
"_note_about_konqueror">Note about konqueror
</h3><div style=
"clear:left"></div>
747 <div class=
"paragraph"><p>When
<em>konqueror
</em> is specified in the
<em>man.viewer
</em> configuration
748 variable, we launch
<em>kfmclient
</em> to try to open the man page on an
749 already opened konqueror in a new tab if possible.
</p></div>
750 <div class=
"paragraph"><p>For consistency, we also try such a trick if
<em>man.konqueror.path
</em> is
751 set to something like
<em>A_PATH_TO/konqueror
</em>. That means we will try to
752 launch
<em>A_PATH_TO/kfmclient
</em> instead.
</p></div>
753 <div class=
"paragraph"><p>If you really want to use
<em>konqueror
</em>, then you can use something like
754 the following:
</p></div>
755 <div class=
"listingblock">
756 <div class=
"content">
761 cmd = A_PATH_TO/konqueror
</tt></pre>
763 <h3 id=
"_note_about_git_config_global">Note about git config --global
</h3><div style=
"clear:left"></div>
764 <div class=
"paragraph"><p>Note that all these configuration variables should probably be set
765 using the
<em>--global
</em> flag, for example like this:
</p></div>
766 <div class=
"listingblock">
767 <div class=
"content">
768 <pre><tt>$ git config --global help.format web
769 $ git config --global web.browser firefox
</tt></pre>
771 <div class=
"paragraph"><p>as they are probably more user specific than repository specific.
772 See
<a href=
"git-config.html">git-config(
1)
</a> for more information about this.
</p></div>
774 <h2 id=
"_git">GIT
</h2>
775 <div class=
"sectionbody">
776 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
779 <div id=
"footnotes"><hr /></div>
781 <div id=
"footer-text">
782 Last updated
2011-
09-
21 23:
01:
14 PDT