git-help.html

   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" />
   6 <meta name="generator" content="AsciiDoc 8.4.5" />
   7 <title>git-help(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-help(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-help -
 411    display help information about git
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="verseblock">
 418 <div class="verseblock-content"><em>git help</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</div>
 419 <div class="verseblock-attribution">
 420 </div></div>
 421 </div>
 422 <h2 id="_description">DESCRIPTION</h2>
 423 <div class="sectionbody">
 424 <div class="paragraph"><p>With no options and no COMMAND given, the synopsis of the <em>git</em>
 425 command and a list of the most commonly used git commands are printed
 426 on the standard output.</p></div>
 427 <div class="paragraph"><p>If the option <em>--all</em> or <em>-a</em> is given, then all available commands are
 428 printed on the standard output.</p></div>
 429 <div class="paragraph"><p>If a git command is named, a manual page for that command is brought
 430 up. The <em>man</em> program is used by default for this purpose, but this
 431 can be overridden by other options or configuration variables.</p></div>
 432 <div class="paragraph"><p>Note that <tt>git --help &#8230;</tt> is identical to <tt>git help &#8230;</tt> because the
 433 former is internally converted into the latter.</p></div>
 434 </div>
 435 <h2 id="_options">OPTIONS</h2>
 436 <div class="sectionbody">
 437 <div class="dlist"><dl>
 438 <dt class="hdlist1">
 439 -a
 440 </dt>
 441 <dt class="hdlist1">
 442 --all
 443 </dt>
 444 <dd>
 445 <p>
 446         Prints all the available commands on the standard output. This
 447         option supersedes any other option.
 448 </p>
 449 </dd>
 450 <dt class="hdlist1">
 451 -i
 452 </dt>
 453 <dt class="hdlist1">
 454 --info
 455 </dt>
 456 <dd>
 457 <p>
 458         Display manual page for the command in the <em>info</em> format. The
 459         <em>info</em> program will be used for that purpose.
 460 </p>
 461 </dd>
 462 <dt class="hdlist1">
 463 -m
 464 </dt>
 465 <dt class="hdlist1">
 466 --man
 467 </dt>
 468 <dd>
 469 <p>
 470         Display manual page for the command in the <em>man</em> format. This
 471         option may be used to override a value set in the
 472         <em>help.format</em> configuration variable.
 473 </p>
 474 <div class="paragraph"><p>By default the <em>man</em> program will be used to display the manual page,
 475 but the <em>man.viewer</em> configuration variable may be used to choose
 476 other display programs (see below).</p></div>
 477 </dd>
 478 <dt class="hdlist1">
 479 -w
 480 </dt>
 481 <dt class="hdlist1">
 482 --web
 483 </dt>
 484 <dd>
 485 <p>
 486         Display manual page for the command in the <em>web</em> (HTML)
 487         format. A web browser will be used for that purpose.
 488 </p>
 489 <div class="paragraph"><p>The web browser can be specified using the configuration variable
 490 <em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of
 491 these config variables is set, the <em>git web&#45;&#45;browse</em> helper script
 492 (called by <em>git help</em>) will pick a suitable default. See
 493 <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a> for more information about this.</p></div>
 494 </dd>
 495 </dl></div>
 496 </div>
 497 <h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
 498 <div class="sectionbody">
 499 <h3 id="_help_format">help.format</h3><div style="clear:left"></div>
 500 <div class="paragraph"><p>If no command line option is passed, the <em>help.format</em> configuration
 501 variable will be checked. The following values are supported for this
 502 variable; they make <em>git help</em> behave as their corresponding command
 503 line option:</p></div>
 504 <div class="ulist"><ul>
 505 <li>
 506 <p>
 507 "man" corresponds to <em>-m|--man</em>,
 508 </p>
 509 </li>
 510 <li>
 511 <p>
 512 "info" corresponds to <em>-i|--info</em>,
 513 </p>
 514 </li>
 515 <li>
 516 <p>
 517 "web" or "html" correspond to <em>-w|--web</em>.
 518 </p>
 519 </li>
 520 </ul></div>
 521 <h3 id="_help_browser_web_browser_and_browser_lt_tool_gt_path">help.browser, web.browser and browser.&lt;tool&gt;.path</h3><div style="clear:left"></div>
 522 <div class="paragraph"><p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.&lt;tool&gt;.path</em> will also
 523 be checked if the <em>web</em> format is chosen (either by command line
 524 option or configuration variable). See <em>-w|--web</em> in the OPTIONS
 525 section above and <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.</p></div>
 526 <h3 id="_man_viewer">man.viewer</h3><div style="clear:left"></div>
 527 <div class="paragraph"><p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format
 528 is chosen. The following values are currently supported:</p></div>
 529 <div class="ulist"><ul>
 530 <li>
 531 <p>
 532 "man": use the <em>man</em> program as usual,
 533 </p>
 534 </li>
 535 <li>
 536 <p>
 537 "woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
 538 (this only works starting with emacsclient versions 22),
 539 </p>
 540 </li>
 541 <li>
 542 <p>
 543 "konqueror": use <em>kfmclient</em> to open the man page in a new konqueror
 544 tab (see <em>Note about konqueror</em> below).
 545 </p>
 546 </li>
 547 </ul></div>
 548 <div class="paragraph"><p>Values for other tools can be used if there is a corresponding
 549 <em>man.&lt;tool&gt;.cmd</em> configuration entry (see below).</p></div>
 550 <div class="paragraph"><p>Multiple values may be given to the <em>man.viewer</em> configuration
 551 variable. Their corresponding programs will be tried in the order
 552 listed in the configuration file.</p></div>
 553 <div class="paragraph"><p>For example, this configuration:</p></div>
 554 <div class="listingblock">
 555 <div class="content">
 556 <pre><tt>        [man]
 557                 viewer = konqueror
 558                 viewer = woman</tt></pre>
 559 </div></div>
 560 <div class="paragraph"><p>will try to use konqueror first. But this may fail (for example if
 561 DISPLAY is not set) and in that case emacs' woman mode will be tried.</p></div>
 562 <div class="paragraph"><p>If everything fails, or if no viewer is configured, the viewer specified
 563 in the GIT_MAN_VIEWER environment variable will be tried.  If that
 564 fails too, the <em>man</em> program will be tried anyway.</p></div>
 565 <h3 id="_man_lt_tool_gt_path">man.&lt;tool&gt;.path</h3><div style="clear:left"></div>
 566 <div class="paragraph"><p>You can explicitly provide a full path to your preferred man viewer by
 567 setting the configuration variable <em>man.&lt;tool&gt;.path</em>. For example, you
 568 can configure the absolute path to konqueror by setting
 569 <em>man.konqueror.path</em>. Otherwise, <em>git help</em> assumes the tool is
 570 available in PATH.</p></div>
 571 <h3 id="_man_lt_tool_gt_cmd">man.&lt;tool&gt;.cmd</h3><div style="clear:left"></div>
 572 <div class="paragraph"><p>When the man viewer, specified by the <em>man.viewer</em> configuration
 573 variables, is not among the supported ones, then the corresponding
 574 <em>man.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
 575 variable exists then the specified tool will be treated as a custom
 576 command and a shell eval will be used to run the command with the man
 577 page passed as arguments.</p></div>
 578 <h3 id="_note_about_konqueror">Note about konqueror</h3><div style="clear:left"></div>
 579 <div class="paragraph"><p>When <em>konqueror</em> is specified in the <em>man.viewer</em> configuration
 580 variable, we launch <em>kfmclient</em> to try to open the man page on an
 581 already opened konqueror in a new tab if possible.</p></div>
 582 <div class="paragraph"><p>For consistency, we also try such a trick if <em>man.konqueror.path</em> is
 583 set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
 584 launch <em>A_PATH_TO/kfmclient</em> instead.</p></div>
 585 <div class="paragraph"><p>If you really want to use <em>konqueror</em>, then you can use something like
 586 the following:</p></div>
 587 <div class="listingblock">
 588 <div class="content">
 589 <pre><tt>        [man]
 590                 viewer = konq
 591
 592         [man "konq"]
 593                 cmd = A_PATH_TO/konqueror</tt></pre>
 594 </div></div>
 595 <h3 id="_note_about_git_config_global">Note about git config --global</h3><div style="clear:left"></div>
 596 <div class="paragraph"><p>Note that all these configuration variables should probably be set
 597 using the <em>--global</em> flag, for example like this:</p></div>
 598 <div class="listingblock">
 599 <div class="content">
 600 <pre><tt>$ git config --global help.format web
 601 $ git config --global web.browser firefox</tt></pre>
 602 </div></div>
 603 <div class="paragraph"><p>as they are probably more user specific than repository specific.
 604 See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
 605 </div>
 606 <h2 id="_git">GIT</h2>
 607 <div class="sectionbody">
 608 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 609 </div>
 610 <div id="footer">
 611 <div id="footer-text">
 612 Last updated 2011-07-23 00:49:30 UTC
 613 </div>
 614 </div>
 615 </body>
 616 </html>